@veltdev/sdk 4.6.7 → 4.6.9

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

@@ -0,0 +1,25 @@
+import { CrdtEventTypes } from "../../utils/enums";
+export type CrdtEventTypesMap = {
+    [CrdtEventTypes.UPDATE_DATA]: CrdtUpdateDataEvent;
+};
+export declare enum CrdtSource {
+    INTERNAL = "internal",
+    EXTERNAL = "external"
+}
+export declare enum CrdtMethodName {
+    UPDATE_DATA = "updateData"
+}
+export type CrdtUpdateDataEvent = {
+    methodName: string;
+    uniqueId: string;
+    timestamp: number;
+    source: string;
+    payload: CrdtUpdateDataPayload;
+};
+export type CrdtUpdateDataPayload = {
+    id: string;
+    data: unknown;
+    lastUpdatedBy: string;
+    sessionId?: string | null;
+    lastUpdate: string;
+};

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

@@ -10,6 +10,7 @@ export interface CrdtVersionWithEncryptedState extends Omit<CrdtVersion, 'state'
 export interface CrdtUpdateDataQuery {
     id: string;
     state: Uint8Array | number[];
+    data?: unknown;
 }
 export interface CrdtOnDataChangeQuery {
     id: string;

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

@@ -1,4 +1,4 @@
-import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSettingsItemType, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
+import { AreaStatus, ArrowStatus, CommentStatus, CrdtActionTypes, HuddleActionTypes, NotificationSettingsItemType, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
 import { DocumentMetadata } from "./document-metadata.model";
 import { DocumentUser } from "./document-user.data.model";
 import { Location } from "./location.model";
@@ -23,7 +23,7 @@ export declare class NotificationRawData {
     /**
      * Type of notification like 'Added', 'Updated' etc.
      */
-    actionType?: AreaStatus | ArrowStatus | CommentStatus | TagStatus | UserActionTypes | HuddleActionTypes;
+    actionType?: AreaStatus | ArrowStatus | CommentStatus | TagStatus | UserActionTypes | HuddleActionTypes | CrdtActionTypes;
     /**
      * Annotation object
      */
@@ -97,6 +97,7 @@ export declare class NotificationRawData {
     notifyUsers?: {
         [email: string]: boolean;
     };
+    crdtData?: unknown;
     notificationSourceData?: any;
 }
 export declare class Notification {

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

@@ -1,3 +1,4 @@
+import { SetDocumentsContext } from "./document.data.model";
 import { UserContact } from "./user-contact.data.model";
 import { UserPermissionAccessRole } from "./user-resolver.data.model";
 export declare class User {
@@ -156,7 +157,7 @@ export interface PermissionQuery {
         type: PermissionResourceType;
         source: PermissionSource;
         organizationId: string;
-        context?: Context;
+        context?: Context | SetDocumentsContext;
     };
 }
 export interface PermissionResult {

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

@@ -1,5 +1,6 @@
 // @ts-nocheck
 import { CrdtGetDataQuery, CrdtGetVersionQuery, CrdtOnDataChangeQuery, CrdtOnPresenceChangeQuery, CrdtOnRegisteredUserChangeQuery, CrdtOnStateChangeQuery, CrdtRegisterSyncUserQuery, CrdtSetPresenceQuery, CrdtSaveVersionQuery, CrdtUpdateDataQuery, CrdtUpdateStateQuery } from "../data/crdt.data.model";
+import { CrdtEventTypesMap } from "../data/crdt-events.data.model";
 
 export declare class CrdtElement {
     /**
@@ -79,6 +80,29 @@ export declare class CrdtElement {
      */
     getVersion: (getVersionQuery: CrdtGetVersionQuery) => Promise<any>;
 
+    /**
+     * Enable webhook
+     */
+    enableWebhook: () => void;
+
+    /**
+     * Disable webhook
+     */
+    disableWebhook: () => void;
+
+    /**
+     * Set webhook debounce time
+     * @param time debounce time in milliseconds
+     */
+    setWebhookDebounceTime: (time: number) => void;
+
+    /**
+     * Subscribe to crdt actions
+     * @param action Action to subscribe to
+     * @returns Observable of the action
+     */
+    on: <T extends keyof CrdtEventTypesMap>(action: T) => Observable<CrdtEventTypesMap[T]>;
+
     constructor();
 
     /**
@@ -163,4 +187,27 @@ export declare class CrdtElement {
      * @param id Document ID
      */
     private _getVersions;
+
+    /**
+     * Enable webhook
+     */
+    private _enableWebhook;
+
+    /**
+     * Disable webhook
+     */
+    private _disableWebhook;
+
+    /**
+     * Set webhook debounce time
+     * @param time debounce time in milliseconds
+     */
+    private _setWebhookDebounceTime;
+
+    /**
+     * Subscribe to crdt actions
+     * @param action Action to subscribe to
+     * @returns Observable of the action
+     */
+    private _on;
 }

package/app/utils/enums.d.ts

@@ -99,12 +99,16 @@ export declare const PresenceEventTypes: {
 export declare const NotificationEventTypes: {
     readonly SETTINGS_UPDATED: "settingsUpdated";
 };
+export declare const CrdtEventTypes: {
+    readonly UPDATE_DATA: "updateData";
+};
 export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
 export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
 export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
 export type LiveStateSyncEventType = typeof LiveStateSyncEventTypes[keyof typeof LiveStateSyncEventTypes];
 export type PresenceEventType = typeof PresenceEventTypes[keyof typeof PresenceEventTypes];
 export type NotificationEventType = typeof NotificationEventTypes[keyof typeof NotificationEventTypes];
+export type CrdtEventType = typeof CrdtEventTypes[keyof typeof CrdtEventTypes];
 export declare enum TagStatus {
     ADDED = "added",
     UPDATED = "updated",
@@ -120,6 +124,9 @@ export declare enum HuddleActionTypes {
     CREATED = "created",
     JOINED = "joined"
 }
+export declare enum CrdtActionTypes {
+    UPDATE_DATA = "updateData"
+}
 export declare enum RecorderStatus {
     ADDED = "added",
     UPDATED = "updated",
@@ -252,7 +259,7 @@ export type RecorderStatusType = 'started' | 'paused' | 'resumed' | 'stopped' |
 export type HuddleType = 'audio' | 'video' | 'presentation';
 export type NotificationTabId = 'for-you' | 'all' | 'document' | 'people';
 export type NotificationTabType = 'forYou' | 'all' | 'documents' | 'people';
-export type NotificationSource = 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
+export type NotificationSource = 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'crdt' | 'custom';
 export type SingleEditorStatus = 'pending' | 'accepted' | 'rejected' | 'cancelled';
 export type SingleEditorState = 'idle' | 'inProgress' | 'completed';
 export type AudioWaveformVariant = 'expanded' | 'minified' | 'player' | 'preview' | 'preview-mini' | 'editor';

package/models.d.ts

@@ -81,4 +81,5 @@ 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';
+export * from './app/models/data/crdt-events.data.model';
 export * from './app/models/data/encryption-provider.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "4.6.7",
+    "version": "4.6.9",
     "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": [