@veltdev/sdk 4.4.0 → 4.5.0-beta.10

package/app/models/data/comment-sidebar-config.model.d.ts

@@ -10,6 +10,7 @@ declare class FilterTypeConfig {
 }
 export declare class CommentSidebarFilterConfig {
     location?: FilterTypeConfig;
+    document?: FilterTypeConfig;
     people?: FilterTypeConfig;
     assigned?: FilterTypeConfig;
     tagged?: FilterTypeConfig;
@@ -25,6 +26,10 @@ export declare class CommentSidebarGroupConfig {
 }
 export declare class CommentSidebarFilters {
     location?: Location[];
+    document?: {
+        id?: string;
+        documentName?: string;
+    }[];
     people?: {
         userId?: string;
         email?: string;

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

@@ -49,6 +49,10 @@ export declare class Config {
      * Default: false
      */
     advancedQueriesDisabled?: boolean;
+    /**
+     * The domain of the API proxy.
+     */
+    apiProxyDomain?: string;
 }
 export interface ExtendedFirebaseOptions extends FirebaseOptions {
     storeDbId: string;

package/app/models/data/live-state-events.data.model.d.ts

@@ -0,0 +1,23 @@
+import { LiveStateSyncEventTypes } from "../../utils/enums";
+import { User } from "./user.data.model";
+export interface AccessRequestEvent {
+    viewer?: User;
+    editor?: User;
+    timestamp?: number;
+    status?: string;
+}
+export interface SEMEvent {
+    viewer?: User;
+    editor?: User;
+    timestamp?: number;
+    role?: string;
+}
+export type LiveStateEventTypesMap = {
+    [LiveStateSyncEventTypes.ACCESS_REQUESTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_REQUEST_CANCELED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_ACCEPTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_REJECTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.EDITOR_ASSIGNED]: SEMEvent;
+    [LiveStateSyncEventTypes.VIEWER_ASSIGNED]: SEMEvent;
+    [LiveStateSyncEventTypes.EDITOR_ON_DIFFERENT_TAB_DETECTED]: SEMEvent;
+};

package/app/models/data/presence-actions.data.model.d.ts

@@ -0,0 +1,5 @@
+export interface PresenceRequestQuery {
+    documentId?: string;
+    organizationId?: string;
+    statuses?: string[];
+}

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

@@ -0,0 +1,16 @@
+import { PresenceEventTypes } from "../../utils/enums";
+import { PresenceUser } from "./presence-user.data.model";
+export interface PresenceMultipleUsersOnlineEvent {
+    users: PresenceUser[];
+}
+export interface PresenceUserStateChangeEvent {
+    user: PresenceUser;
+    state: string;
+}
+export type PresenceEventTypesMap = {
+    [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
+    [PresenceEventTypes.USER_STATE_CHANGE]: PresenceUserStateChangeEvent;
+};
+export interface GetPresenceDataResponse {
+    data: PresenceUser[] | null;
+}

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

@@ -81,4 +81,6 @@ export declare class PresenceUser {
     isAnonymous?: boolean;
     pageInfo: PageInfo;
     initial?: string;
+    isTabAway?: boolean;
+    isUserIdle?: boolean;
 }

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

@@ -163,11 +163,28 @@ export interface RecorderAnnotationEditVersion {
     waveformData?: number[];
     displayName?: string;
     boundedTrimRanges?: RecorderBoundedTrimRange[];
+    boundedScaleRanges?: RecorderBoundedScaleRange[];
 }
 export interface RecorderBoundedTrimRange {
     start: number;
     end: number;
 }
+export interface RecorderBoundedScaleRange {
+    start: number;
+    end: number;
+    zoomInDuration?: number;
+    holdDuration?: number;
+    zoomOutDuration?: number;
+    zoomFactor?: number;
+    centerX?: number;
+    centerY?: number;
+    topLeftX?: number;
+    topLeftY?: number;
+}
+export interface RecorderEditRange {
+    trimRanges: RecorderBoundedTrimRange[];
+    scaleRanges: RecorderBoundedScaleRange[];
+}
 export declare class RecorderMetadata extends BaseMetadata {
     [key: string]: any;
 }
@@ -184,6 +201,7 @@ declare class RecorderDataTranscription {
     contentSummary?: string;
 }
 declare class RecorderDataAsset {
+    version?: number;
     url: string;
     mimeType?: string;
     fileName?: string;
@@ -201,6 +219,7 @@ export declare class RecorderData {
     from?: User | null;
     metadata?: RecorderMetadata;
     assets: RecorderDataAsset[];
+    assetsAllVersions: RecorderDataAsset[];
     transcription: RecorderDataTranscription;
 }
 export interface RecorderRequestQuery {
@@ -211,4 +230,6 @@ export interface GetRecordingDataResponse {
 }
 export interface GetRecordingsResponse extends RecorderData {
 }
+export interface DeleteRecordingsResponse extends RecorderData {
+}
 export {};

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

@@ -6,8 +6,21 @@ export interface RecordingDoneEvent extends RecorderData {
 }
 export interface RecordingDeleteEvent extends RecorderData {
 }
+export interface RecordingEditDoneEvent extends RecorderData {
+}
+export interface RecordingErrorEvent {
+    type: string;
+    message: string;
+    recorderId?: string;
+}
+export interface RecordingSaveInitiatedEvent {
+    annotationId?: string;
+    message: string;
+    type: 'edit' | 'record';
+}
 export type RecorderEventTypesMap = {
     [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
     [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;
+    [RecorderEventTypes.RECORDING_EDIT_DONE]: RecordingEditDoneEvent;
     [RecorderEventTypes.DELETE_RECORDING]: RecordingDeleteEvent;
 };

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

@@ -93,3 +93,15 @@ export declare class RecordedData {
     };
     getThumbnailTag: (url?: string) => string;
 }
+export declare class RecorderQualityConstraintsOptions {
+    video?: MediaTrackConstraints;
+    audio?: MediaTrackConstraints;
+}
+export declare class RecorderQualityConstraints {
+    safari?: RecorderQualityConstraintsOptions;
+    other?: RecorderQualityConstraintsOptions;
+}
+export declare class RecorderEncodingOptions {
+    safari?: MediaRecorderOptions;
+    other?: MediaRecorderOptions;
+}

package/app/models/element/live-state-sync-element.model.d.ts

@@ -2,6 +2,7 @@
 import { SingleEditorConfig, UserEditorAccess, EditorAccessTimer, LiveStateDataConfig, SetLiveStateDataConfig } from '../data/live-state-data.data.model';
 import { User } from '../data/user.data.model';
 import { ServerConnectionState } from '../../utils/enums';
+import { LiveStateEventTypesMap } from '../data/live-state-events.data.model';
 
 /**
  * Represents the synchronization element for live state.
@@ -141,6 +142,11 @@ export declare class LiveStateSyncElement {
      */
     onServerConnectionStateChange: () => Observable<ServerConnectionState>;
 
+    /**
+     * Subscribe to live state events
+     */
+    on: <T extends keyof LiveStateEventTypesMap>(action: T) => Observable<LiveStateEventTypesMap[T]>;
+
     /**
      * Constructor for LiveStateSyncElement.
      */
@@ -278,4 +284,9 @@ export declare class LiveStateSyncElement {
      * To get server connection state
      */
     private _onServerConnectionStateChange;
+
+    /**
+     * Subscribe to live state events
+     */
+    private _on;
 }

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

@@ -1,6 +1,9 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { PresenceUser } from "../data/presence-user.data.model";
+import { GetPresenceDataResponse, PresenceEventTypesMap } from "../data/presence-events.data.model";
+import { PresenceRequestQuery } from "../data/presence-actions.data.model";
+
 export declare class PresenceElement {
 
     /**
@@ -36,6 +39,16 @@ export declare class PresenceElement {
      * To disable adding self to the presence list
      */
     disableSelf: () => void;
+
+    /**
+     * To get the presence data
+     */
+    getData: (query?: PresenceRequestQuery) => Observable<GetPresenceDataResponse>;
+
+    /**
+     * Subscribe to presence events
+     */
+    on: <T extends keyof PresenceEventTypesMap>(action: T) => Observable<PresenceEventTypesMap[T]>;
     constructor();
     /**
      * Subscribe to a list of all online users who are either active or inactive on the current document.
@@ -70,4 +83,14 @@ export declare class PresenceElement {
      * To disable adding self to the presence list
      */
     private _disableSelf;
+
+    /**
+     * To get the presence data
+     */
+    private _getData;
+
+    /**
+     * Subscribe to presence events
+     */
+    private _on;
 }

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

@@ -1,8 +1,8 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse, GetRecordingsResponse } from "../data/recorder-annotation.data.model";
+import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse, GetRecordingsResponse, DeleteRecordingsResponse } from "../data/recorder-annotation.data.model";
 import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
-import { RecordedData } from "../data/recorder.model";
+import { RecordedData, RecorderQualityConstraints, RecorderEncodingOptions } from "../data/recorder.model";
 
 export declare class RecorderElement {
 
@@ -69,6 +69,21 @@ export declare class RecorderElement {
      */
     fetchRecordings: (query?: RecorderRequestQuery) => Promise<GetRecordingsResponse[]>;
 
+    /**
+     * To delete recordings
+     */
+    deleteRecordings: (query?: RecorderRequestQuery) => Promise<DeleteRecordingsResponse[]>;
+
+    /**
+     * To set recording quality constraints
+     */
+    setRecordingQualityConstraints: (constraints: RecorderQualityConstraints) => void;
+
+    /**
+     * To set recording encoding options
+     */
+    setRecordingEncodingOptions: (options: RecorderEncodingOptions) => void;
+
     constructor();
 
     private _initRecording;
@@ -133,4 +148,19 @@ export declare class RecorderElement {
      * To fetch recordings
      */
     private _fetchRecordings;
+
+    /**
+     * To delete recordings
+     */
+    private _deleteRecordings;
+
+    /**
+     * To set recording quality constraints
+     */
+    private _setRecordingQualityConstraints;
+
+    /**
+     * To set recording encoding options
+     */
+    private _setRecordingEncodingOptions;
 }

package/app/utils/enums.d.ts

@@ -58,7 +58,10 @@ export declare const CommentEventTypes: {
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";
     readonly RECORDING_DONE: "recordingDone";
+    readonly RECORDING_EDIT_DONE: "recordingEditDone";
     readonly DELETE_RECORDING: "deleteRecording";
+    readonly ERROR: "error";
+    readonly RECORDING_SAVE_INITIATED: "recordingSaveInitiated";
 };
 export declare const CoreEventTypes: {
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
@@ -66,9 +69,24 @@ export declare const CoreEventTypes: {
     readonly DOCUMENT_INIT: "documentInit";
     readonly ERROR: "error";
 };
+export declare const LiveStateSyncEventTypes: {
+    readonly ACCESS_REQUESTED: "accessRequested";
+    readonly ACCESS_REQUEST_CANCELED: "accessRequestCanceled";
+    readonly ACCESS_ACCEPTED: "accessAccepted";
+    readonly ACCESS_REJECTED: "accessRejected";
+    readonly EDITOR_ASSIGNED: "editorAssigned";
+    readonly VIEWER_ASSIGNED: "viewerAssigned";
+    readonly EDITOR_ON_DIFFERENT_TAB_DETECTED: "editorOnDifferentTabDetected";
+};
+export declare const PresenceEventTypes: {
+    readonly MULTIPLE_USERS_ONLINE: "multipleUsersOnline";
+    readonly USER_STATE_CHANGE: "userStateChange";
+};
 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 declare enum TagStatus {
     ADDED = "added",
     UPDATED = "updated",
@@ -238,7 +256,7 @@ export type ReactionPinType = 'timeline' | 'comment';
 export type SidebarPosition = 'left' | 'right';
 export type SidebarSortingCriteria = 'date' | 'unread' | null;
 export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved';
-export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'pages' | 'statuses' | 'priorities' | 'categories' | 'versions';
+export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions';
 export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
 export type NotificationPanelMode = 'popover' | 'sidebar';
 export type SidebarActionButtonType = 'default' | 'toggle';

package/models.d.ts

@@ -28,6 +28,7 @@ export * from './app/models/data/document-user.data.model';
 export * from './app/models/data/huddle.model';
 export * from './app/models/data/live-state-data-map.data.model';
 export * from './app/models/data/live-state-data.data.model';
+export * from './app/models/data/live-state-events.data.model';
 export * from './app/models/data/localstorage.data.model';
 export * from './app/models/data/location-metadata.model';
 export * from './app/models/data/location.model';
@@ -37,6 +38,8 @@ export * from './app/models/data/notification.model';
 export * from './app/models/data/page-info.model';
 export * from './app/models/data/permission.data.model';
 export * from './app/models/data/presence-user.data.model';
+export * from './app/models/data/presence-actions.data.model';
+export * from './app/models/data/presence-events.data.model';
 export * from './app/models/data/recorder.model';
 export * from './app/models/data/recorder-annotation.data.model';
 export * from './app/models/data/recorder-events.data.model';

package/package.json

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