@veltdev/sdk 4.0.0-beta.1 → 4.0.0-beta.10

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

@@ -26,6 +26,7 @@ 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;
@@ -48,6 +49,10 @@ export declare class Snippyly {
    * @param id unique document ID
    */
   setDocumentId: (id: string) => void;
+  /**
+   * To set multiple documents
+   */
+  setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
   /**
    * To unset the document id
    */

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

@@ -59,11 +59,10 @@ 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[];
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;

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

@@ -126,18 +126,15 @@ export interface DeleteCommentAnnotationEvent {
     commentAnnotation: CommentAnnotation;
     metadata: VeltEventMetadata;
 }
-export interface GetCommentAnnotationEvent {
-    commentAnnotations: CommentAnnotation[];
-    metadata: VeltEventMetadata;
-}
-export interface GetCommentAnnotationResponse {
-    [documentId: string]: CommentAnnotation[];
+export interface GetCommentAnnotationsResponse {
+    data: Record<string, CommentAnnotation[]> | null;
 }
 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.data.model.d.ts

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

@@ -1,13 +1,13 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
-import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
+import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent, GetCommentAnnotationsResponse, GetCommentAnnotationsCountResponse } from "../data/comment-events.data.model";
 import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
 import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
 import { AutocompleteData } from "../data/autocomplete.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
-import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
+import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, CommentRequestQuery, CommentRequestQuery, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
 import { UnreadCommentsCount } from "../data/comment-utils.data.model";
 export declare class CommentElement {
   /**
@@ -921,132 +921,142 @@ export declare class CommentElement {
   /**
    * To add comment annotation
    */
-  public addCommentAnnotation: (config: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
+  public addCommentAnnotation: (request: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
 
   /**
    * To approve comment annotation
    */
-  public approveCommentAnnotation: (config: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
+  public approveCommentAnnotation: (request: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
 
   /**
    * To accept comment annotation
    */
-  public acceptCommentAnnotation: (config: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
+  public acceptCommentAnnotation: (request: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
 
   /**
    * To reject comment annotation
    */
-  public rejectCommentAnnotation: (config: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
+  public rejectCommentAnnotation: (request: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
 
   /**
    * To subscribe comment annotation
    */
-  public subscribeCommentAnnotation: (config: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
+  public subscribeCommentAnnotation: (request: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
 
   /**
    * To unsubscribe comment annotation
    */
-  public unsubscribeCommentAnnotation: (config: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
+  public unsubscribeCommentAnnotation: (request: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
 
   /**
    * To delete comment annotation
    */
-  public deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
+  public deleteCommentAnnotation: (request: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
+
+  /**
+   * To get comment annotations
+   */
+  public getCommentAnnotations: (query?: CommentRequestQuery) => Observable<GetCommentAnnotationsResponse>;
+
+  /**
+   * To get comment annotations count
+   */
+  public getCommentAnnotationsCount: (query?: CommentRequestQuery) => Observable<GetCommentAnnotationsCountResponse>;
 
   /**
    * To assign user to comment annotation
    */
-  public assignUser: (config: AssignUserRequest) => Promise<AssignUserEvent | null>;
+  public assignUser: (request: AssignUserRequest) => Promise<AssignUserEvent | null>;
 
   /**
    * To update priority
    */
-  public updatePriority: (config: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
+  public updatePriority: (request: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
 
   /**
    * To update status
    */
-  public updateStatus: (config: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
+  public updateStatus: (request: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
 
   /**
    * To update access
    */
-  public updateAccess: (config: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
+  public updateAccess: (request: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
 
   /**
    * To resolve comment annotation
    */
-  public resolveCommentAnnotation: (config: ResolveCommentAnnotationRequest) => Promise<any>;
+  public resolveCommentAnnotation: (request: ResolveCommentAnnotationRequest) => Promise<any>;
 
   /**
    * To get link
    */
-  public getLink: (config: GetLinkRequest) => Promise<GetLinkEvent | null>;
+  public getLink: (request: GetLinkRequest) => Promise<GetLinkEvent | null>;
 
   /**
    * To copy link
    */
-  public copyLink: (config: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
+  public copyLink: (request: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
 
   /**
    * To add comment
    */
-  public addComment: (config: AddCommentRequest) => Promise<AddCommentEvent | null>;
+  public addComment: (request: AddCommentRequest) => Promise<AddCommentEvent | null>;
 
   /**
    * To update comment
    */
-  public updateComment: (config: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
+  public updateComment: (request: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
 
   /**
    * To delete comment
    */
-  public deleteComment: (config: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
+  public deleteComment: (request: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
 
   /**
    * To get comment
    */
-  public getComment: (config: GetCommentRequest) => Promise<Comment[]>;
+  public getComment: (request: GetCommentRequest) => Promise<Comment[]>;
 
   /**
    * To add attachment
    */
-  public addAttachment: (config: AddAttachmentRequest) => Promise<AddAttachmentResponse[]>;
+  public addAttachment: (request: AddAttachmentRequest) => Promise<AddAttachmentResponse[]>;
 
   /**
    * To get attachment
    */
-  public getAttachment: (config: GetAttachmentRequest) => Promise<Attachment[]>;
+  public getAttachment: (request: GetAttachmentRequest) => Promise<Attachment[]>;
 
   /**
    * To delete attachment
    */
-  public deleteAttachment: (config: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
+  public deleteAttachment: (request: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
 
   /**
    * To get recording
    */
-  public getRecording: (config: GetRecordingRequest) => Promise<RecordedData[]>;
+  public getRecording: (request: GetRecordingRequest) => Promise<RecordedData[]>;
 
   /**
    * To delete recording
    */
-  public deleteRecording: (config: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
+  public deleteRecording: (request: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
 
   /**
    * To add reaction
    */
-  public addReaction: (config: AddReactionRequest) => Promise<AddReactionEvent | null>;
+  public addReaction: (request: AddReactionRequest) => Promise<AddReactionEvent | null>;
 
   /**
    * To delete reaction
    */
-  public deleteReaction: (config: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
+  public deleteReaction: (request: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
 
   /**
    * To toggle reaction
    */
-  public toggleReaction: (config: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
+  public toggleReaction: (request: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
 
   /**
    * Subscribe to comment actions
@@ -1998,6 +2008,16 @@ export declare class CommentElement {
    */
   private _deleteCommentAnnotation;
 
+  /**
+   * To get comment annotations
+   */
+  private _getCommentAnnotations;
+
+  /**
+   * To get comment annotations count
+   */
+  private _getCommentAnnotationsCount;
+
   /**
    * To assign user to comment annotation
    */

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

@@ -1,6 +1,7 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { RecorderData } from "../data/recorder-annotation.data.model";
+import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
 
 export declare class RecorderElement {
 
@@ -33,6 +34,11 @@ export declare class RecorderElement {
      */
     disableRecordingTranscription: () => void;
 
+    /**
+     * Subscribe to recorder actions
+     */
+    public on: <T extends keyof RecorderEventTypesMap>(action: T) => Observable<RecorderEventTypesMap[T]>;
+
     constructor();
 
     private _initRecording;
@@ -63,4 +69,9 @@ export declare class RecorderElement {
      * To disable recording transcription
      */
     private _disableRecordingTranscription;
+
+    /**
+     * Subscribe to recorder actions
+     */
+    private _on;
 }

package/app/utils/enums.d.ts

@@ -42,10 +42,14 @@ export declare const CommentEventTypes: {
     readonly COMMENT_SIDEBAR_DATA_INIT: "commentSidebarDataInit";
     readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
 };
+export declare const RecorderEventTypes: {
+    readonly TRANSCRIPTION_DONE: "transcriptionDone";
+};
 export declare const CoreEventTypes: {
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
 };
 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 declare enum TagStatus {
     ADDED = "added",

package/models.d.ts

@@ -16,6 +16,7 @@ export * from './app/models/data/cursor-user.data.model';
 export * from './app/models/data/custom-css.data.model';
 export * from './app/models/data/custom-chip-dropdown.data.model';
 export * from './app/models/data/device-info.model';
+export * from './app/models/data/document.data.model';
 export * from './app/models/data/document-iam.data.model';
 export * from './app/models/data/document-metadata.model';
 export * from './app/models/data/document-paths.data.model';
@@ -33,6 +34,7 @@ export * from './app/models/data/permission.data.model';
 export * from './app/models/data/presence-user.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';
 export * from './app/models/data/rewriter-annotation.data.model';
 export * from './app/models/data/screen-size.data.model';
 export * from './app/models/data/selection.model';

package/package.json

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