@veltdev/sdk-staging 4.0.0-beta.1 → 4.0.0-beta.100

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

@@ -26,6 +26,10 @@ 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";
+
 export declare class Snippyly {
   constructor();
   initConfig: (apiKey: string, config?: Config) => void;
@@ -46,33 +50,44 @@ export declare class Snippyly {
   /**
    * 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;
   /**
-   * Get Document ID
+   * To unset the documents
    */
-  getDocumentId: () => string;
+  unsetDocuments: () => void;
   /**
-   * 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.
+   * To fetch documents
    */
-  setDocumentParams: (params: Location) => void;
+  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 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
@@ -178,12 +193,6 @@ export declare class Snippyly {
    * @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
@@ -211,17 +220,6 @@ export declare class Snippyly {
    */
   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 snippyly specific content from provided html content.
-   */
-  removeSnippylyContent: (htmlContent: string) => string;
-
   /**
    * To remove velt specific content from provided html content.
    */
@@ -262,6 +260,7 @@ export declare class Snippyly {
 
    /**
     * To get document metadata.
+    * @deprecated This method is deprecated and will be removed in next release.
     */
    getDocumentMetadata: () => Observable<DocumentMetadata | null>;
 

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

@@ -0,0 +1,51 @@
+import { AnnotationProperty } from "./annotation-property.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { Location } from "./location.model";
+import { PageInfo } from "./page-info.model";
+import { TargetElement } from "./target-element.data.model";
+import { User } from "./user.data.model";
+export declare class ArrowAnnotation {
+    /**
+     * Unique identifier for the arrow pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * The user who created this arrow pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * Color used for the arrow pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * Timestamp when the arrow annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Target element of attached annotation.
+     */
+    targetElement?: TargetElement | null;
+    position?: CursorPosition | null;
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    type?: string;
+    props: AnnotationProperty;
+    /**
+     * To maintain index of current annotation in available list of annotations
+     * It will start from 1, so no need to add 1 in that.
+     */
+    annotationIndex?: number;
+    pageInfo?: PageInfo;
+}

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;
@@ -59,11 +61,13 @@ export interface DeleteCommentAnnotationRequest {
     annotationId: string;
     options?: RequestOptions;
 }
-export interface GetCommentAnnotationRequest {
-    options?: RequestOptions;
-}
-export interface GetCommentAnnotationsCountRequest {
-    options?: RequestOptions;
+export interface CommentRequestQuery {
+    documentIds?: string[];
+    locationIds?: string[];
+    statusIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;
@@ -162,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

@@ -126,18 +126,18 @@ export interface DeleteCommentAnnotationEvent {
     commentAnnotation: CommentAnnotation;
     metadata: VeltEventMetadata;
 }
-export interface GetCommentAnnotationEvent {
-    commentAnnotations: CommentAnnotation[];
-    metadata: VeltEventMetadata;
+export interface GetCommentAnnotationsResponse {
+    data: Record<string, CommentAnnotation[]> | null;
 }
-export interface GetCommentAnnotationResponse {
-    [documentId: string]: CommentAnnotation[];
+export interface FetchCommentAnnotationsResponse extends GetCommentAnnotationsResponse {
+    nextPageToken: string;
 }
 export interface GetCommentAnnotationsCountResponse {
-    [documentId: string]: {
-        total: number;
-        unread: number;
-    };
+    data: Record<string, CommentAnnotationsCount> | null;
+}
+export interface CommentAnnotationsCount {
+    unread: number;
+    total: number;
 }
 export interface SubscribeCommentAnnotationEvent {
     annotationId: string;

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

@@ -12,6 +12,7 @@ export declare class CommentSidebarFilterConfig {
     location?: FilterTypeConfig;
     people?: FilterTypeConfig;
     priority?: FilterTypeConfig;
+    status?: FilterTypeConfig;
     category?: FilterTypeConfig;
     commentType?: FilterTypeConfig;
     version?: FilterTypeConfig;

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,10 @@
+import { DocumentMetadata } from "./document-metadata.model";
+import { FolderMetadata } from "./folder-metadata.model";
+export interface FetchDocumentsResponse {
+    data: Record<string, DocumentMetadata[]> | null;
+    nextPageToken: string;
+}
+export interface FetchFoldersResponse {
+    data: Record<string, FolderMetadata[]> | null;
+    nextPageToken: string;
+}

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

@@ -0,0 +1,27 @@
+import { DocumentMetadata } from "./document-metadata.model";
+export interface Document {
+    id: string;
+    metadata?: DocumentMetadata;
+}
+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;
+}

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

@@ -2,7 +2,7 @@ import { DocumentMetadata } from "./document-metadata.model";
 import { Location } from "./location.model";
 import { OrganizationMetadata } from "./organization-metadata.model";
 export interface VeltEventMetadata {
-    organizationMetadata?: OrganizationMetadata | null;
-    documentMetadata?: DocumentMetadata | null;
-    location?: Location | null;
+    organization?: OrganizationMetadata | null;
+    documents?: DocumentMetadata[];
+    locations?: Location[];
 }

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

@@ -0,0 +1,61 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+import { CommentAnnotation, GhostComment, InlineCommentSectionConfig } from "./comment-annotation.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { Location } from "./location.model";
+import { TargetElement } from "./target-element.data.model";
+import { TargetTextRange } from "./target-text-range.data.model";
+import { User } from "./user.data.model";
+export declare class MultiThreadCommentAnnotation {
+    /**
+     * The id of the annotation.
+     */
+    annotationId: string;
+    /**
+     * The id of the area annotation.
+     */
+    areaAnnotationId?: string;
+    /**
+     * The target element of the annotation.
+     */
+    targetElement?: TargetElement | null;
+    /**
+     * The id of the target element.
+     */
+    targetElementId?: string | null;
+    /**
+     * Selected text range of comment annotation
+     */
+    targetTextRange?: TargetTextRange | null;
+    /**
+     * The id of the target inline comment element.
+     */
+    targetInlineCommentElementId?: string;
+    /**
+     * The inline comment section config.
+     */
+    inlineCommentSectionConfig?: InlineCommentSectionConfig;
+    commentAnnotations?: {
+        [commentAnnotationId: string]: boolean;
+    };
+    commentAnnotationsMap?: {
+        [commentAnnotationId: string]: CommentAnnotation;
+    };
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    position?: CursorPosition | null;
+    ghostComment?: GhostComment | null;
+    from: User;
+    type: string;
+    isDraft?: boolean;
+    sourceId?: string;
+    metadata?: MultiThreadMetadata;
+}
+export declare class MultiThreadMetadata extends BaseMetadata {
+    [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,16 @@
+import { RecorderEventTypes } from "../../utils/enums";
+export interface TranscriptionDoneEvent {
+    transcription: string;
+    id?: string;
+    tag?: string;
+    type?: string;
+    thumbnailUrl?: string;
+    thumbnailWithPlayIconUrl?: string;
+    videoUrl?: string;
+    audioUrl?: string;
+    videoPlayerUrl?: string;
+    getThumbnailTag?: (url?: string) => string;
+}
+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;
+}