@veltdev/sdk 4.5.0-beta.2 → 4.5.0-beta.20

package/app/client/snippyly.model.d.ts

@@ -31,6 +31,7 @@ import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/doc
 import { UserDataProvider } from "../models/data/user-resolver.data.model";
 import { VeltDataProvider } from "../models/data/provider.data.model";
 import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
+import { SetLocationsRequestOptions } from "../models/data/location.model";
 
 export declare class Snippyly {
    constructor();
@@ -48,17 +49,22 @@ export declare class Snippyly {
     * @param id unique document ID
     * @param documentMetadata Document Metadata
     */
-   setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
+   setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<void>;
    /**
     * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
     * @param id unique document ID
     * @deprecated This method is deprecated. Use `setDocuments` method instead.
     */
-   setDocumentId: (id: string) => void;
+   setDocumentId: (id: string) => Promise<void>;
    /**
     * To set multiple documents
     */
-   setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
+   setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => Promise<void>;
+   /**
+    * To set the root document
+    * @param document Document object
+    */
+   setRootDocument: (document: Document) => Promise<void>;
    /**
     * To unset the document id
     * @deprecated This method is deprecated. Use `unsetDocuments` method instead.
@@ -100,12 +106,39 @@ export declare class Snippyly {
     * @param params Location
     * @param appendLocation Append location to existing location
     */
-   setLocation: (params: Location, appendLocation?: boolean) => void;
+   setLocation: (params: Location, appendLocation?: boolean) => Promise<void>;
+
+   /**
+    * To set the root location
+    * @param location Location object
+    */
+   setRootLocation: (location: Location) => Promise<void>;
+
+   /**
+    * To set multiple locations
+    * @param locations Location objects
+    * @param options Set locations options
+    */
+   setLocations: (locations: Location[], options?: SetLocationsRequestOptions) => Promise<void>;
+
    /**
       * To remove location from a User
       * @param location Location
       */
    removeLocation: (location?: Location) => void;
+
+   /**
+    * To remove multiple locations
+    * @param locations Location objects
+    */
+   removeLocations: (locations?: Location[]) => void;
+
+   /**
+    * To remove location ids
+    * @param locationIds Location ids
+    */
+   unsetLocationIds: (locationIds?: string[]) => void;
+
    /**
     * To exclude data of specific location ids
     * @param ids Location Ids
@@ -211,7 +244,7 @@ export declare class Snippyly {
    * @param location Location object
    * @deprecated This method is deprecated and will be removed in next release. Use `setLocation` method with `appendLocation: true` instead.
    */
-   addLocation: (location: any) => any;
+   addLocation: (location: any) => Promise<any>;
    /**
     * To set the dark mode of Velt components.
     * @param value {boolean} true/false
@@ -315,5 +348,5 @@ export declare class Snippyly {
    /**
     * To reset the button toggle map.
     */
-  resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
+   resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
 }

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

@@ -164,6 +164,10 @@ export declare class CommentAnnotation {
      * Custom context data provided by the user
      */
     context?: any;
+    /**
+     * Context id generated from context data
+     */
+    contextId?: string;
     iam: CommentIAMConfig;
     isPageAnnotation?: boolean;
     targetInlineCommentElementId?: string;
@@ -244,3 +248,6 @@ export declare class CommentAnnotationSubscribedGroups {
 export declare class UpdateContextConfig {
     merge?: boolean;
 }
+export interface ContextOptions {
+    partialMatch?: boolean;
+}

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/document-paths.data.model.d.ts

@@ -3,10 +3,18 @@ export declare class DocumentPaths {
      * The document's unique identifier.
      */
     documentId?: string;
+    folderId?: string;
+    locationId?: string;
+    allDocuments?: boolean;
+    veltFolderId?: string;
     /**
      * Presence path.
      */
     presence?: string;
+    /**
+     * User config path.
+     */
+    userConfig?: string;
     docs?: string;
     /**
      * Cursor path.

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

@@ -8,6 +8,7 @@ export interface SetDocumentsRequestOptions {
     folderId?: string;
     allDocuments?: boolean;
     locationId?: string;
+    rootDocumentId?: string;
 }
 export interface UpdateDocumentsRequest<T = unknown> {
     organizationId?: string;

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

@@ -23,3 +23,13 @@ export declare class Version {
      */
     name: string;
 }
+export declare class SetLocationsRequestOptions {
+    /**
+     * Root location.
+     */
+    rootLocationId?: string;
+    /**
+     * Merge locations.
+     */
+    appendLocation?: boolean;
+}

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

@@ -1,4 +1,4 @@
-import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
+import { AreaStatus, ArrowStatus, CommentStatus, 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";
@@ -230,3 +230,22 @@ export declare class NotificationTabConfig {
     all?: NotificationTabConfigItem;
     people?: NotificationTabConfigItem;
 }
+export declare class NotificationInitialSettingsConfig {
+    name?: string;
+    id: string;
+    default?: string;
+    enable?: boolean;
+    values?: NotificationConfigValue[];
+}
+export declare class NotificationConfigValue {
+    name?: string;
+    id: NotificationSettingsItemType;
+}
+export declare class NotificationSettingsConfig {
+    [key: string]: NotificationSettingsItemType;
+}
+export interface NotificationsDocConfig {
+    inbox: 'ALL' | 'NONE' | 'MINE';
+    email: 'ALL' | 'NONE' | 'MINE';
+    [key: string]: string;
+}

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

@@ -0,0 +1,9 @@
+import { NotificationSettingsConfig } from "./notification.model";
+import { NotificationEventTypes } from "../../utils/enums";
+export interface SettingsUpdatedEvent {
+    settings: NotificationSettingsConfig;
+    isMutedAll: boolean;
+}
+export type NotificationEventTypesMap = {
+    [NotificationEventTypes.SETTINGS_UPDATED]: SettingsUpdatedEvent;
+};

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

@@ -3,6 +3,14 @@ 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/recorder-annotation.data.model.d.ts

@@ -180,6 +180,8 @@ export interface RecorderBoundedScaleRange {
     centerY?: number;
     topLeftX?: number;
     topLeftY?: number;
+    topLeftXPixels?: number;
+    topLeftYPixels?: number;
 }
 export interface RecorderEditRange {
     trimRanges: RecorderBoundedTrimRange[];
@@ -213,6 +215,7 @@ declare class RecorderDataAsset {
      */
     fileFormat?: RecorderFileFormat;
     thumbnailUrl?: string;
+    transcription: RecorderDataTranscription;
 }
 export declare class RecorderData {
     recorderId: string;
@@ -230,4 +233,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

@@ -8,6 +8,16 @@ 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;

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/data/resolver.data.model.d.ts

@@ -3,6 +3,12 @@ export interface ResolverConfig {
     saveRetryConfig?: RetryConfig;
     deleteRetryConfig?: RetryConfig;
     getRetryConfig?: RetryConfig;
+    resolveUsersConfig?: ResolveUsersConfig;
+}
+export interface ResolveUsersConfig {
+    organization?: boolean;
+    folder?: boolean;
+    document?: boolean;
 }
 export interface ResolverResponse<T> {
     data?: T;

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

@@ -1,5 +1,7 @@
+import { ResolverConfig } from "./resolver.data.model";
 import { User } from "./user.data.model";
 export interface UserDataProvider {
     get(userIds: string[]): Promise<Record<string, User>>;
+    config?: ResolverConfig;
     resolveTimeout?: number;
 }

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

@@ -1140,6 +1140,17 @@ export declare class CommentElement {
    * To disable draft mode
    */
   public disableDraftMode: () => void;
+
+  /**
+   * To enable filter comments on dom
+   */
+  public enableFilterCommentsOnDom: () => void;
+
+  /**
+   * To disable filter comments on dom
+   */
+  public disableFilterCommentsOnDom: () => void;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -2260,4 +2271,14 @@ export declare class CommentElement {
    * To disable draft mode
    */
   private _disableDraftMode;
+
+  /**
+   * To enable filter comments on dom
+   */
+  private _enableFilterCommentsOnDom;
+
+  /**
+   * To disable filter comments on dom
+   */
+  private _disableFilterCommentsOnDom;
 }

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

@@ -1,6 +1,6 @@
 // @ts-nocheck
 
-import { Notification, NotificationTabConfig } from "../data/notification.model";
+import { Notification, NotificationTabConfig, NotificationSettingsConfig, NotificationInitialSettingsConfig } from "../data/notification.model";
 
 export declare class NotificationElement {
     /**
@@ -58,6 +58,36 @@ export declare class NotificationElement {
      */
     markNotificationAsReadById: (notificationId: string) => void;
 
+    /**
+     * To set settings
+     */
+    setSettings: (config: NotificationSettingsConfig) => void;
+
+    /**
+     * To get settings
+     */
+    getSettings: () => NotificationSettingsConfig;
+
+    /**
+     * To mute all notifications
+     */
+    muteAllNotifications: () => void;
+
+    /**
+     * To enable settings
+     */
+    enableSettings: () => void;
+
+    /**
+     * To disable settings
+     */
+    disableSettings: () => void;
+
+    /**
+     * To set settings initial config
+     */
+    setSettingsInitialConfig: (settings: NotificationInitialSettingsConfig[]) => void;
+
     constructor();
 
     /**
@@ -114,4 +144,34 @@ export declare class NotificationElement {
      * To mark notification as read by id
      */
     private _markNotificationAsReadById;
+
+    /**
+     * To set settings
+     */
+    private _setSettings;
+
+    /**
+     * To get settings
+     */
+    private _getSettings;
+
+    /**
+     * To mute all notifications
+     */
+    private _muteAllNotifications;
+
+    /**
+     * To enable settings
+     */
+    private _enableSettings;
+
+    /**
+     * To disable settings
+     */
+    private _disableSettings;
+
+    /**
+     * To set settings initial config
+     */
+    private _setSettingsInitialConfig;
 }

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

@@ -1,13 +1,16 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { PresenceUser } from "../data/presence-user.data.model";
-import { PresenceEventTypesMap } from "../data/presence-events.data.model";
+import { GetPresenceDataResponse, PresenceEventTypesMap } from "../data/presence-events.data.model";
+import { PresenceRequestQuery } from "../data/presence-actions.data.model";
+
 export declare class PresenceElement {
 
     /**
      * Subscribe to a list of all online users who are either active or inactive on the current document.
      *
      * Returns Observable<PresenceUser[] | null>.
+     * @deprecated This method is deprecated. Use `getData` method instead.
      */
     getOnlineUsersOnCurrentDocument: () => Observable<PresenceUser[] | null>;
 
@@ -38,6 +41,11 @@ export declare class PresenceElement {
      */
     disableSelf: () => void;
 
+    /**
+     * To get the presence data
+     */
+    getData: (query?: PresenceRequestQuery) => Observable<GetPresenceDataResponse>;
+
     /**
      * Subscribe to presence events
      */
@@ -47,6 +55,7 @@ export declare class PresenceElement {
      * Subscribe to a list of all online users who are either active or inactive on the current document.
      *
      * Returns Observable<PresenceUser[] | null>.
+     * @deprecated This method is deprecated. Use `getData` method instead.
      */
     private _getOnlineUsersOnCurrentDocument;
 
@@ -77,6 +86,11 @@ export declare class PresenceElement {
      */
     private _disableSelf;
 
+    /**
+     * To get the presence data
+     */
+    private _getData;
+
     /**
      * Subscribe to presence events
      */

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,26 @@ 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;
+
+    /**
+     * To download latest video
+     */
+    downloadLatestVideo: (recorderId: string) => Promise<boolean>;
+
     constructor();
 
     private _initRecording;
@@ -133,4 +153,24 @@ 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;
+
+    /**
+     * To download latest video
+     */
+    private _downloadLatestVideo;
 }

package/app/utils/constants.d.ts

@@ -12,6 +12,7 @@ export declare class Constants {
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
     static FIREBASE_PARTIAL_PATH_FOLDERS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;
+    static FIREBASE_PARTIAL_PATH_DOCUMENT_CONFIGURATIONS: string;
     static FIREBASE_PARTIAL_PATH_PRESENCE: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATION_USERS: string;
     static FIREBASE_PARTIAL_PATH_FOLDER_USERS: string;

package/app/utils/enums.d.ts

@@ -60,10 +60,13 @@ export declare const RecorderEventTypes: {
     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";
     readonly USER_UPDATE: "userUpdate";
+    readonly INIT_UPDATE: "initUpdate";
     readonly DOCUMENT_INIT: "documentInit";
     readonly ERROR: "error";
 };
@@ -78,12 +81,17 @@ export declare const LiveStateSyncEventTypes: {
 };
 export declare const PresenceEventTypes: {
     readonly MULTIPLE_USERS_ONLINE: "multipleUsersOnline";
+    readonly USER_STATE_CHANGE: "userStateChange";
+};
+export declare const NotificationEventTypes: {
+    readonly SETTINGS_UPDATED: "settingsUpdated";
 };
 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 declare enum TagStatus {
     ADDED = "added",
     UPDATED = "updated",
@@ -253,7 +261,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';
@@ -261,3 +269,11 @@ export declare enum CommentSidebarSystemFiltersOperator {
     AND = "and",
     OR = "or"
 }
+/**
+ * Type for notification settings accordion types
+ */
+export type NotificationSettingsAccordionType = 'inbox' | 'email' | string;
+/**
+ * Type for notification settings item options
+ */
+export type NotificationSettingsItemType = 'ALL' | 'MINE' | 'NONE' | string;

package/models.d.ts

@@ -35,9 +35,11 @@ export * from './app/models/data/location.model';
 export * from './app/models/data/media-preview-config.data.model';
 export * from './app/models/data/multi-thread.data.model';
 export * from './app/models/data/notification.model';
+export * from './app/models/data/notifications-events.data.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';

package/package.json

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