@veltdev/sdk-dev 4.0.0-beta.14 → 4.0.0-beta.140

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

@@ -26,210 +26,208 @@ 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 } 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 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;
+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";
 
-  /**
-   * To check if user allowed in provided document or not.
-   */
-  isUserAllowed$: () => Observable<boolean>;
+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 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
+    * @deprecated This method is deprecated and will be removed in next release. 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 and will be removed in next release. 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;
+   /**
+    * To set the dark mode of Velt components.
+    * @param value {boolean} true/false
+    */
+   setDarkMode: (darkMode: boolean) => void;
 
-  /**
-   * To get user role in provided document.
-   */
-  getUserRole$: () => Observable<string | null>;
+   /**
+    * To check if user allowed in provided document or not.
+    */
+   isUserAllowed$: () => Observable<boolean>;
 
-  /**
-   * To check if plan is expired or not.
-   */
-  isPlanExpired$: () => Observable<boolean>;
+   /**
+    * To get user.
+    */
+   getUser: () => User | null;
 
-  /**
-   * To get if the Velt is initialized or not.
-   * @returns Observable<boolean | undefined>
-   */
-  getVeltInitState: () => Observable<boolean | undefined>;
+   /**
+    * To get user role in provided document.
+    */
+   getUserRole$: () => Observable<string | null>;
 
-  /**
-   * To invite list of users to the document.
-   * @param documentUsers List of document users
-   */
-  inviteUsers: (documentUsers: Array<DocumentUser>) => void;
+   /**
+    * To check if plan is expired or not.
+    */
+   isPlanExpired$: () => Observable<boolean>;
 
-  /**
-   * To remove snippyly specific content from provided html content.
-   */
-  removeSnippylyContent: (htmlContent: string) => string;
+   /**
+    * To get if the Velt is initialized or not.
+    * @returns Observable<boolean | undefined>
+    */
+   getVeltInitState: () => Observable<boolean | undefined>;
 
-  /**
-   * To remove velt specific content from provided html content.
-   */
+   /**
+    * To remove velt specific content from provided html content.
+    */
    removeVeltContent: (htmlContent: string) => string;
 
    /**
@@ -244,11 +242,10 @@ export declare class Snippyly {
    setLanguage: (language: string) => void;
 
    /**
-    * To set the translations for the language.
-    * @param language Language code
-    * @param translations Translations object
+    * To set translations for multiple languages
+    * @param translations Object containing translations for multiple languages
     */
-   setTranslations: (language: string, translations: { [key: string]: string }) => void;
+   setTranslations: (translations: { [language: string]: { [key: string]: string } }) => void;
 
    /**
     * To enable auto translation.
@@ -263,10 +260,11 @@ 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>;
 
@@ -274,4 +272,14 @@ 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>;
+}

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

@@ -4,4 +4,6 @@ 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,8 +9,10 @@ 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;
@@ -63,6 +65,9 @@ export interface CommentRequestQuery {
     documentIds?: string[];
     locationIds?: string[];
     statusIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;
@@ -161,3 +166,18 @@ 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,6 +77,8 @@ 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;
@@ -129,6 +131,9 @@ 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;
 }
@@ -235,3 +240,13 @@ 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/config.data.model.d.ts

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

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

@@ -0,0 +1,8 @@
+import { DocumentMetadata } from "./document-metadata.model";
+import { FolderMetadata } from "./folder-metadata.model";
+export interface FetchDocumentsResponse {
+    data: Record<string, DocumentMetadata> | null;
+}
+export interface FetchFoldersResponse {
+    data: Record<string, FolderMetadata> | null;
+}

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

@@ -6,6 +6,14 @@ 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,4 +5,27 @@ 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/folder-metadata.model.d.ts

@@ -0,0 +1,40 @@
+export declare class FolderMetadata {
+    folderId?: string;
+    /**
+     * Velt folder id
+     */
+    veltFolderId?: string;
+    /**
+     * Parent folder id
+     */
+    parentFolderId?: string;
+    /**
+     * Velt parent folder id
+     */
+    veltParentFolderId?: string;
+    /**
+     * Created at
+     */
+    createdAt?: number;
+    /**
+     * Last updated
+     */
+    lastUpdated?: number;
+    /**
+     * API key
+     */
+    apiKey?: string;
+    /**
+     * Organization id
+     */
+    organizationId?: string;
+    /**
+     * Client organization id
+     */
+    clientOrganizationId?: string;
+    /**
+     * Folder name
+     */
+    folderName?: string;
+    [key: string]: any;
+}

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

@@ -88,6 +88,11 @@ export declare class NotificationRawData {
         [key: string]: any;
     };
     displayBodyMessage?: string;
+    displayBodyMessageTemplate?: string;
+    displayBodyMessageTemplateData?: {
+        users?: User[];
+        [key: string]: any;
+    };
     customData?: any;
     notifyUsers?: {
         [email: string]: boolean;
@@ -127,6 +132,17 @@ 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,4 +164,10 @@ export declare class RecorderData {
     assets: RecorderDataAsset[];
     transcription: RecorderDataTranscription;
 }
+export interface RecorderRequestQuery {
+    recorderIds: string[];
+}
+export interface GetRecordingDataResponse {
+    data: Record<string, RecorderData> | null;
+}
 export {};

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

@@ -0,0 +1,8 @@
+import { RecorderEventTypes } from "../../utils/enums";
+import { RecorderData } from "./recorder-annotation.data.model";
+export interface TranscriptionDoneEvent {
+    data: Record<string, RecorderData> | null;
+}
+export type RecorderEventTypesMap = {
+    [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
+};

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

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