@veltdev/sdk-staging 4.0.0-beta.113 → 4.0.0-beta.12

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

@@ -26,214 +26,210 @@ import { DocumentMetadata } from "../models/data/document-metadata.model";
 import { ReactionElement } from "../models/element/reaction-element.model";
 import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
 import { CoreEventTypesMap } from "../models/data/core-events.data.model";
-import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest } from "../models/data/document.data.model";
-import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
-import { UserDataProvider } from "../models/data/user-resolver.data.model";
-
+import { Document, SetDocumentsRequestOptions } from "../models/data/document.data.model";
 export declare class Snippyly {
-   constructor();
-   initConfig: (apiKey: string, config?: Config) => void;
-   identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
-   /**
-    * Tell us who the currently logged in user is.
-    *
-    * Call whenever the user is updated: signs in, signs out, signs up etc.
-    * @deprecated This method is deprecated.
-    */
-   updateUser: (user: User) => void;
-   /**
-    * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
-    * @param id unique document ID
-    * @param documentMetadata Document Metadata
-    */
-   setDocument: (id: string, documentMetadata?: DocumentMetadata) => 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;
-   /**
-    * To set multiple documents
-    */
-   setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
-   /**
-    * To unset the document id
-    * @deprecated This method is deprecated. Use `unsetDocuments` method instead.
-    */
-   unsetDocumentId: () => void;
-   /**
-    * To unset the documents
-    */
-   unsetDocuments: () => void;
-   /**
-    * To fetch documents
-    */
-   fetchDocuments: (options?: FetchDocumentsRequest) => Promise<FetchDocumentsResponse>;
-   /**
-    * To fetch folders
-    */
-   fetchFolders: (options?: FetchFoldersRequest) => Promise<FetchFoldersResponse>;
-   /**
-    * To set the user data provider.
-    */
-   setUserDataProvider: (userDataProvider: UserDataProvider) => void;
-   /**
-    * Get Document ID
-    */
-   getDocumentId: () => string;
-   /**
-    * Tell us the custom params of the current document/resource to identify sub document inside a document.
-    * @param params Location
-    * @param appendLocation Append location to existing location
-    */
-   setLocation: (params: Location, appendLocation?: boolean) => void;
-   /**
-      * To remove location from a User
-      * @param location Location
-      */
-   removeLocation: (location?: Location) => void;
-   /**
-    * To exclude data of specific location ids
-    * @param ids Location Ids
-    */
-   excludeLocationIds: (ids: string[]) => void;
-   /**
-    * Tell us the about the scrollable document ids to keep track on its scroll changes
-    * @param ids scrollable elements ids
-    */
-   setScrollableElementsIds: (ids: string[]) => void;
-   /**
-    * To remove document params from a User
-    */
-   removeScrollableElementsIds: () => void;
-   /**
-    * Get the Presence Element Object to access the raw presence data.
-    *
-    * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
-    */
-   getPresenceElement: () => PresenceElement;
-   /**
-    * Get the Cursor Element Object to access the raw cursor data.
-    *
-    * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
-    */
-   getCursorElement: () => CursorElement;
-   /**
-    * Get the Comment Element Object to access the raw comment data.
-    *
-    * This is for Pros who don’t want to use Snippyly Comment web component and want to design their own UI.
-    */
-   getCommentElement: () => CommentElement;
-   /**
-    * Get the Tag Pin Annotation Object to access the raw tag data.
-    *
-    * This is for Pros who don’t want to use Snippyly Tag web component and want to design their own UI.
-    */
-   getTagElement: () => TagElement;
-   /**
-    * Get the Selection Object to enable/disable the feature.
-    */
-   getSelectionElement: () => SelectionElement;
-   /**
-    * Get the Recorder Object.
-    */
-   getRecorderElement: () => RecorderElement;
-   /**
-    * Get the Contact Object.
-    */
-   getContactElement: () => ContactElement;
-   /**
-    * Get the Rewriter Object.
-    */
-   getRewriterElement: () => RewriterElement;
-   /**
-    * Get the Huddle element.
-    */
-   getHuddleElement: () => HuddleElement;
-   /**
-    * Get the LiveStateSync Object.
-    */
-   getLiveStateSyncElement: () => LiveStateSyncElement;
-   /**
-    * Get the Arrow Object.
-    */
-   getArrowElement: () => ArrowElement;
-   /**
-    * Get the Views Object.
-    */
-   getViewsElement: () => ViewsElement;
-   /**
-    * Get the Notification Object.
-    */
-   getNotificationElement: () => NotificationElement;
-   /**
-    * Get the Autocomplete Object.
-    */
-   getAutocompleteElement: () => AutocompleteElement;
-   /**
-    * Get the Area Object.
-    */
-   getAreaElement: () => AreaElement;
-   /**
-    * Get the Area Object.
-    */
-   getReactionElement: () => ReactionElement;
-   /**
-    * Get the metadata of the current resource.
-    */
-   getMetadata: () => Promise<VeltEventMetadata | null>;
-   /**
-    * To signout a user
-    */
-   signOutUser: () => any;
-   /**
-    * Provide a list of features to disable.
-    * Provide an empty array to enable all the features.
-    * @param features List of features
-    */
-   disableFeatures: (features: Array<FeatureType>) => void;
-   /**
+  constructor();
+  initConfig: (apiKey: string, config?: Config) => void;
+  identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
+  /**
+   * Tell us who the currently logged in user is.
+   *
+   * Call whenever the user is updated: signs in, signs out, signs up etc.
+   * @deprecated This method is deprecated and will be removed in next release.
+   */
+  updateUser: (user: User) => void;
+  /**
+   * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
+   * @param id unique document ID
+   * @param documentMetadata Document Metadata
+   */
+  setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
+  /**
+   * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
+   * @param id unique document ID
+   */
+  setDocumentId: (id: string) => void;
+  /**
+   * To set multiple documents
+   */
+  setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
+  /**
+   * To unset the document id
+   */
+  unsetDocumentId: () => void;
+  /**
+   * Get Document ID
+   */
+  getDocumentId: () => string;
+  /**
+   * Tell us the custom params of the current document/resource to identify sub document inside a document.
+   * @param params Document Params
+   * @deprecated This method is depercated and will be removed in next release. Use `setLocation` method instead.
+   */
+  setDocumentParams: (params: Location) => void;
+  /**
+   * Tell us the custom params of the current document/resource to identify sub document inside a document.
+   * @param params Location
+   * @param appendLocation Append location to existing location
+   */
+  setLocation: (params: Location, appendLocation?: boolean) => void;
+  /**
+   * To remove document params from a User
+   * @deprecated This method is depercated and will be removed in next release. Use `removeLocation` method instead.
+   */
+  removeDocumentParams: () => void;
+  /**
+     * To remove location from a User
+     * @param location Location
+     */
+  removeLocation: (location?: Location) => void;
+  /**
+   * To exclude data of specific location ids
+   * @param ids Location Ids
+   */
+  excludeLocationIds: (ids: string[]) => void;
+  /**
+   * Tell us the about the scrollable document ids to keep track on its scroll changes
+   * @param ids scrollable elements ids
+   */
+  setScrollableElementsIds: (ids: string[]) => void;
+  /**
+   * To remove document params from a User
+   */
+  removeScrollableElementsIds: () => void;
+  /**
+   * Get the Presence Element Object to access the raw presence data.
+   *
+   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+   */
+  getPresenceElement: () => PresenceElement;
+  /**
+   * Get the Cursor Element Object to access the raw cursor data.
+   *
+   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+   */
+  getCursorElement: () => CursorElement;
+  /**
+   * Get the Comment Element Object to access the raw comment data.
+   *
+   * This is for Pros who don’t want to use Snippyly Comment web component and want to design their own UI.
+   */
+  getCommentElement: () => CommentElement;
+  /**
+   * Get the Tag Pin Annotation Object to access the raw tag data.
+   *
+   * This is for Pros who don’t want to use Snippyly Tag web component and want to design their own UI.
+   */
+  getTagElement: () => TagElement;
+  /**
+   * Get the Selection Object to enable/disable the feature.
+   */
+  getSelectionElement: () => SelectionElement;
+  /**
+   * Get the Recorder Object.
+   */
+  getRecorderElement: () => RecorderElement;
+  /**
+   * Get the Contact Object.
+   */
+  getContactElement: () => ContactElement;
+  /**
+   * Get the Rewriter Object.
+   */
+  getRewriterElement: () => RewriterElement;
+  /**
+   * Get the Huddle element.
+   */
+  getHuddleElement: () => HuddleElement;
+  /**
+   * Get the LiveStateSync Object.
+   */
+  getLiveStateSyncElement: () => LiveStateSyncElement;
+  /**
+   * Get the Arrow Object.
+   */
+  getArrowElement: () => ArrowElement;
+  /**
+   * Get the Views Object.
+   */
+  getViewsElement: () => ViewsElement;
+  /**
+   * Get the Notification Object.
+   */
+  getNotificationElement: () => NotificationElement;
+  /**
+   * Get the Autocomplete Object.
+   */
+  getAutocompleteElement: () => AutocompleteElement;
+  /**
+   * Get the Area Object.
+   */
+  getAreaElement: () => AreaElement;
+  /**
+   * Get the Area Object.
+   */
+  getReactionElement: () => ReactionElement;
+  /**
+   * Get the metadata of the current resource.
+   */
+  getMetadata: () => Promise<VeltEventMetadata | null>;
+  /**
+   * To signout a user
+   */
+  signOutUser: () => any;
+  /**
+   * Provide a list of features to disable.
+   * Provide an empty array to enable all the features.
+   * @param features List of features
+   */
+  disableFeatures: (features: Array<FeatureType>) => void;
+  /**
    * Add location to show comments, tags, recorders etc. for provided location also.
    * @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;
-   /**
-    * To set the dark mode of Velt components.
-    * @param value {boolean} true/false
-    */
-   setDarkMode: (darkMode: boolean) => void;
+  addLocation: (location: any) => any;
+  /**
+   * To set the dark mode of Velt components.
+   * @param value {boolean} true/false
+   */
+  setDarkMode: (darkMode: boolean) => void;
 
-   /**
-    * To check if user allowed in provided document or not.
-    */
-   isUserAllowed$: () => Observable<boolean>;
+  /**
+   * To check if user allowed in provided document or not.
+   */
+  isUserAllowed$: () => Observable<boolean>;
 
-   /**
-    * To get user.
-    */
-   getUser: () => User | null;
+  /**
+   * To get user role in provided document.
+   */
+  getUserRole$: () => Observable<string | null>;
 
-   /**
-    * To get user role in provided document.
-    */
-   getUserRole$: () => Observable<string | null>;
+  /**
+   * To check if plan is expired or not.
+   */
+  isPlanExpired$: () => Observable<boolean>;
 
-   /**
-    * To check if plan is expired or not.
-    */
-   isPlanExpired$: () => Observable<boolean>;
+  /**
+   * To get if the Velt is initialized or not.
+   * @returns Observable<boolean | undefined>
+   */
+  getVeltInitState: () => Observable<boolean | undefined>;
 
-   /**
-    * To get if the Velt is initialized or not.
-    * @returns Observable<boolean | undefined>
-    */
-   getVeltInitState: () => Observable<boolean | undefined>;
+  /**
+   * To invite list of users to the document.
+   * @param documentUsers List of document users
+   */
+  inviteUsers: (documentUsers: Array<DocumentUser>) => void;
 
-   /**
-    * To remove velt specific content from provided html content.
-    */
+  /**
+   * To remove snippyly specific content from provided html content.
+   */
+  removeSnippylyContent: (htmlContent: string) => string;
+
+  /**
+   * To remove velt specific content from provided html content.
+   */
    removeVeltContent: (htmlContent: string) => string;
 
    /**
@@ -267,11 +263,10 @@ export declare class Snippyly {
    /**
     * To update user contact list.
     */
-   updateContactList: (userContacts: UserContact[], config?: { merge: boolean }) => void;
+   updateContactList: (userContacts: UserContact[], config?: {merge: boolean}) => void;
 
    /**
     * To get document metadata.
-    * @deprecated This method is deprecated. Use `fetchDocuments` method instead.
     */
    getDocumentMetadata: () => Observable<DocumentMetadata | null>;
 
@@ -279,24 +274,4 @@ export declare class Snippyly {
     * To subscribe to core actions
     */
    on: <T extends keyof CoreEventTypesMap>(action: T) => Observable<CoreEventTypesMap[T]>;
-
-   /**
-   * To set the ui state.
-   */
-   setUiState: <T extends object>(uiState: T) => void;
-
-   /**
-    * To get the ui state.
-    */
-   getUiState: <T extends object>() => Observable<T>;
-
-   /**
-    * To enable logs.
-    */
-   enableLogs: () => void;
-
-   /**
-    * To disable logs.
-    */
-   disableLogs: () => void;
-}
+}

package/app/models/data/base-metadata.data.model.d.ts

@@ -4,6 +4,4 @@ export declare class BaseMetadata {
     clientDocumentId?: string;
     organizationId?: string;
     clientOrganizationId?: string;
-    folderId?: string;
-    veltFolderId?: string;
 }

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

@@ -9,10 +9,8 @@ import { User } from "./user.data.model";
 export interface RequestOptions {
     organizationId?: string;
     documentId?: string;
-    folderId?: string;
     filters?: any;
     documentIds?: string[];
-    allDocuments?: boolean;
 }
 export interface UpdatePriorityRequest {
     annotationId: string;
@@ -65,9 +63,6 @@ export interface CommentRequestQuery {
     documentIds?: string[];
     locationIds?: string[];
     statusIds?: string[];
-    folderId?: string;
-    allDocuments?: boolean;
-    locationId?: string;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;
@@ -166,18 +161,3 @@ export interface ToggleReactionRequest {
     };
     options?: RequestOptions;
 }
-export interface FetchCommentAnnotationsRequest {
-    createdAfter?: number;
-    createdBefore?: number;
-    updatedAfter?: number;
-    updatedBefore?: number;
-    statusIds?: string[];
-    order?: 'asc' | 'desc';
-    pageToken?: string;
-    allDocuments?: boolean;
-    pageSize?: number;
-    organizationId?: string;
-    locationId?: string;
-    documentIds?: string[];
-    folderId?: string;
-}

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

@@ -77,8 +77,6 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.TOGGLE_REACTION]: ToggleReactionEvent;
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_INIT]: CommentSidebarDataInitEvent;
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
-    [CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
-    [CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -131,9 +129,6 @@ export interface DeleteCommentAnnotationEvent {
 export interface GetCommentAnnotationsResponse {
     data: Record<string, CommentAnnotation[]> | null;
 }
-export interface FetchCommentAnnotationsResponse extends GetCommentAnnotationsResponse {
-    nextPageToken: string;
-}
 export interface GetCommentAnnotationsCountResponse {
     data: Record<string, CommentAnnotationsCount> | null;
 }
@@ -240,13 +235,3 @@ export interface CommentSidebarDataInitEvent extends VeltButtonClickEvent {
 }
 export interface CommentSidebarDataUpdateEvent extends VeltButtonClickEvent {
 }
-export interface AutocompleteSearchEvent {
-    event: KeyboardEvent | InputEvent | Event;
-    searchText: string;
-    type?: 'contact' | 'custom' | 'group';
-    metadata?: VeltEventMetadata;
-}
-export interface ComposerClickedEvent {
-    commentAnnotation?: CommentAnnotation;
-    metadata?: VeltEventMetadata;
-}

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

@@ -6,11 +6,3 @@ export interface IUnreadCommentsCount {
     count: number;
 }
 export type UnreadCommentsCount = IUnreadCommentsCount | null;
-export interface TransformContext {
-    containerSelector: string;
-    transforms: {
-        scale: number;
-        transformOrigin: string;
-        inverseScale?: number;
-    };
-}

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

@@ -52,7 +52,6 @@ export declare class Config {
 }
 export interface ExtendedFirebaseOptions extends FirebaseOptions {
     storeDbId: string;
-    region?: string;
 }
 export interface AdvancedQueries {
     advancedQueriesEnabled: boolean;

package/app/models/data/cursor-position.data.model.d.ts

@@ -7,19 +7,4 @@ export declare class CursorPosition {
      * Position left of cursor on viewer user's screen
      */
     left: number;
-    /**
-     * Scale factor of the parent element in X direction
-     * Used for transform handling
-     */
-    parentScaleX?: number;
-    /**
-     * Scale factor of the parent element in Y direction
-     * Used for transform handling
-     */
-    parentScaleY?: number;
-    /**
-     * Transform context information
-     * Used to handle transforms properly
-     */
-    transformContext?: any;
 }

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

@@ -6,14 +6,6 @@ export declare class DocumentMetadata {
      * Unique document id generated from client document id
      */
     documentId?: string;
-    /**
-     * Folders
-     */
-    folderId?: string;
-    /**
-     * Velt folder id
-     */
-    veltFolderId?: string;
     /**
      * API key
      */

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

@@ -5,27 +5,4 @@ export interface Document {
 }
 export interface SetDocumentsRequestOptions {
     organizationId?: string;
-    folderId?: string;
-    allDocuments?: boolean;
-    locationId?: string;
-}
-export interface FetchDocumentsRequest {
-    organizationId?: string;
-    documentIds?: string[];
-    folderId?: string;
-    allDocuments?: boolean;
-}
-export interface FetchFoldersRequest {
-    organizationId?: string;
-    folderId?: string;
-}
-export interface FolderConfig {
-    folderId?: string;
-    allDocuments?: boolean;
-    locationId?: string;
-    veltFolderId?: string;
-}
-export interface OrganizationConfig {
-    organizationId: string;
-    clientOrganizationId: string;
 }

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

@@ -88,11 +88,6 @@ export declare class NotificationRawData {
         [key: string]: any;
     };
     displayBodyMessage?: string;
-    displayBodyMessageTemplate?: string;
-    displayBodyMessageTemplateData?: {
-        users?: User[];
-        [key: string]: any;
-    };
     customData?: any;
     notifyUsers?: {
         [email: string]: boolean;
@@ -132,17 +127,6 @@ export declare class Notification {
      * Notification body message
      */
     displayBodyMessage?: string;
-    /**
-       * Display body message template
-       */
-    displayBodyMessageTemplate?: string;
-    /**
-     * Display body message template data
-     */
-    displayBodyMessageTemplateData?: {
-        users?: User[];
-        [key: string]: any;
-    };
     /**
      * Display message template
      */

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

@@ -164,10 +164,4 @@ export declare class RecorderData {
     assets: RecorderDataAsset[];
     transcription: RecorderDataTranscription;
 }
-export interface RecorderRequestQuery {
-    recorderIds: string[];
-}
-export interface GetRecordingDataResponse {
-    data: Record<string, RecorderData> | null;
-}
 export {};