@veltdev/sdk 4.5.0-beta.57 → 4.5.0-beta.58

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

@@ -0,0 +1,56 @@
+export interface CrdtVersion {
+    versionId: string;
+    versionName?: string;
+    state: Uint8Array | number[];
+    timestamp: number;
+}
+export interface CrdtUpdateDataQuery {
+    id: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtOnDataChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtGetDataQuery {
+    id: string;
+}
+export interface CrdtOnStateChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtUpdateStateQuery {
+    id: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtRegisterSyncUserQuery {
+    id: string;
+}
+export interface CrdtOnRegisteredUserChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtSetPresenceQuery {
+    id: string;
+}
+export interface CrdtOnPresenceChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtStoreVersionQuery {
+    id: string;
+    versionId: string;
+    versionName?: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtGetVersionQuery {
+    id: string;
+    versionId: string;
+}
+export interface CrdtGetVersionsQuery {
+    id: string;
+}
+export interface CrdtDeleteVersionQuery {
+    id: string;
+    versionId: string;
+}

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

@@ -1,11 +1,13 @@
 // @ts-nocheck
+import { CrdtGetDataQuery, CrdtGetVersionQuery, CrdtOnDataChangeQuery, CrdtOnPresenceChangeQuery, CrdtOnRegisteredUserChangeQuery, CrdtOnStateChangeQuery, CrdtRegisterSyncUserQuery, CrdtSetPresenceQuery, CrdtStoreVersionQuery, CrdtUpdateDataQuery, CrdtUpdateStateQuery } from "../data/crdt.data.model";
+
 export declare class CrdtElement {
     /**
      * Update data for a specific CRDT document
      * @param id Document ID
      * @param state State data as Uint8Array or number array
      */
-    updateData: ({ id, state }: { id: string, state: Uint8Array | number[] }) => Promise<any>;
+    updateData: (updateDataQuery: CrdtUpdateDataQuery) => Promise<any>;
 
     /**
      * Subscribe to data changes for a specific CRDT document
@@ -13,13 +15,13 @@ export declare class CrdtElement {
      * @param callback Callback function to handle data changes
      * @returns Unsubscribe function
      */
-    onDataChange: ({ id, callback }: { id: string, callback: (data: any) => void }) => () => void;
+    onDataChange: (onDataChangeQuery: CrdtOnDataChangeQuery) => () => void;
 
     /**
      * Get data for a specific CRDT document
      * @param id Document ID
      */
-    getData: ({ id }: { id: string }) => Promise<any>;
+    getData: (getDataQuery: CrdtGetDataQuery) => Promise<any>;
 
     /**
      * Subscribe to state changes for a specific CRDT document
@@ -27,26 +29,31 @@ export declare class CrdtElement {
      * @param callback Callback function to handle state changes
      * @returns Unsubscribe function
      */
-    onStateChange: ({ id, callback }: { id: string, callback: (data: any) => void }) => () => void;
+    onStateChange: (onStateChangeQuery: CrdtOnStateChangeQuery) => () => void;
 
     /**
      * Update state for a specific CRDT document
      * @param id Document ID
      * @param state State data as Uint8Array or number array
      */
-    updateState: ({ id, state }: { id: string, state: Uint8Array | number[] }) => Promise<any>;
+    updateState: (updateStateQuery: CrdtUpdateStateQuery) => Promise<any>;
 
     /**
      * Register a user for synchronization on a specific CRDT document
      * @param id Document ID
      */
-    registerSyncUser: ({ id }: { id: string }) => Promise<void>;
+    registerSyncUser: (registerSyncUserQuery: CrdtRegisterSyncUserQuery) => Promise<void>;
+
+    /**
+     * Subscribe to registered user changes for a specific CRDT document
+     */
+    onRegisteredUserChange: (onRegisteredUserChangeQuery: CrdtOnRegisteredUserChangeQuery) => () => void;
 
     /**
      * Set presence for a specific CRDT document
      * @param id Document ID
      */
-    setPresence: ({ id }: { id: string }) => Promise<void>;
+    setPresence: (setPresenceQuery: CrdtSetPresenceQuery) => Promise<void>;
 
     /**
      * Subscribe to presence changes for a specific CRDT document
@@ -54,7 +61,23 @@ export declare class CrdtElement {
      * @param callback Callback function to handle presence changes
      * @returns Unsubscribe function
      */
-    onPresenceChange: ({ id, callback }: { id: string, callback: (data: any) => void }) => () => void;
+    onPresenceChange: (onPresenceChangeQuery: CrdtOnPresenceChangeQuery) => () => void;
+
+    /**
+     * Store a version of a specific CRDT document
+     * @param id Document ID
+     * @param versionId Version ID
+     * @param versionName Version name
+     * @param state State data as Uint8Array or number array
+     */
+    storeVersion: (storeVersionQuery: CrdtStoreVersionQuery) => Promise<any>;
+
+    /**
+     * Get a version of a specific CRDT document
+     * @param id Document ID
+     * @param versionId Version ID
+     */
+    getVersion: (getVersionQuery: CrdtGetVersionQuery) => Promise<any>;
 
     constructor();
 
@@ -100,6 +123,11 @@ export declare class CrdtElement {
      */
     private _registerSyncUser;
 
+    /**
+     * Subscribe to registered user changes for a specific CRDT document
+     */
+    private _onRegisteredUserChange;
+
     /**
      * Set presence for a specific CRDT document
      * @param id Document ID
@@ -113,4 +141,26 @@ export declare class CrdtElement {
      * @returns Unsubscribe function
      */
     private _onPresenceChange;
+
+    /**
+     * Store a version of a specific CRDT document
+     * @param id Document ID
+     * @param versionId Version ID
+     * @param versionName Version name
+     * @param state State data as Uint8Array or number array
+     */
+    private _storeVersion;
+
+    /**
+     * Get a version of a specific CRDT document
+     * @param id Document ID
+     * @param versionId Version ID
+     */
+    private _getVersion;
+
+    /**
+     * Get all versions of a specific CRDT document
+     * @param id Document ID
+     */
+    private _getVersions;
 }

package/models.d.ts

@@ -77,3 +77,4 @@ export * from './app/models/data/event-metadata.data.model';
 export * from './app/models/data/user-resolver.data.model';
 export * from './app/models/data/provider.data.model';
 export * from './app/models/data/resolver.data.model';
+export * from './app/models/data/crdt.data.model';

package/package.json

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