@veltdev/sdk 4.3.0-beta.5 → 4.3.0-beta.6

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

@@ -1,3 +1,4 @@
+import { RecorderFileFormat } from "../../utils/enums";
 export declare class Attachment {
     /**
      * Unique identifier for the comment pin annotation.
@@ -20,7 +21,7 @@ export declare class Attachment {
     /**
      * File type
      */
-    type?: string;
+    type?: RecorderFileFormat;
     /**
      * Download url of a file
      */

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

@@ -3,24 +3,24 @@ import { BaseMetadata } from "./base-metadata.data.model";
 import { CommentAnnotation } from "./comment-annotation.data.model";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface CommentAnnotationDataProvider {
-    get: (request: GetCommentRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
-    save: (request: SaveCommentRequest) => Promise<ResolverResponse<undefined>>;
-    delete: (request: DeleteCommentRequest) => Promise<ResolverResponse<undefined>>;
+    get: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
+    save: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    delete: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
-export interface GetCommentRequest {
+export interface GetCommentResolverRequest {
     organizationId: string;
     commentAnnotationIds?: string[];
     documentIds?: string[];
     folderId?: string;
     allDocuments?: boolean;
 }
-export interface DeleteCommentRequest {
+export interface DeleteCommentResolverRequest {
     commentAnnotationId: string;
     metadata?: BaseMetadata;
     event?: ResolverActions;
 }
-export interface SaveCommentRequest {
+export interface SaveCommentResolverRequest {
     commentAnnotation: {
         [key: string]: PartialCommentAnnotation;
     };

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

@@ -1,9 +1,9 @@
-import { ClientOrganizationUserGroup } from "./organization-groups.data.model";
+import { UserGroup } from "./organization-groups.data.model";
 import { User } from "./user.data.model";
 export interface GetContactListResponse {
     organizationUsers?: User[];
     folderUsers?: User[];
     documentUsers?: User[];
-    userGroups?: ClientOrganizationUserGroup[];
+    userGroups?: UserGroup[];
     updatedContactList?: User[];
 }

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

@@ -1,5 +1,15 @@
 import { CoreEventTypes } from "../../utils/enums";
 import { VeltButtonClickEvent } from "./button.data.model";
+import { User } from "./user.data.model";
 export type CoreEventTypesMap = {
     [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
+    [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
+    [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
+    [CoreEventTypes.ERROR]: ErrorEvent;
+};
+export type UserUpdateEvent = User | null;
+export type DocumentInitEvent = boolean | undefined;
+export type ErrorEvent = {
+    code: string;
+    message?: string;
 };

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

@@ -1,3 +1,4 @@
+import { HuddleType } from "../../utils/enums";
 import { User } from "./user.data.model";
 export declare class Attendee extends User {
     state?: {
@@ -12,7 +13,7 @@ export declare class Attendee extends User {
         screenSharing?: boolean;
     };
     streamMetadata?: any;
-    initialHuddleType?: 'audio' | 'video' | 'presentation';
+    initialHuddleType?: HuddleType;
     huddleOnCursorMode?: boolean;
 }
 export declare class Message {

package/app/models/data/live-state-data.data.model.d.ts

@@ -1,3 +1,4 @@
+import { SingleEditorState, SingleEditorStatus } from "../../utils/enums";
 import { User } from "./user.data.model";
 export declare class LiveStateData {
     /**
@@ -24,7 +25,7 @@ export declare class SingleEditorLiveStateData {
     requestEditorAccess?: {
         user: User;
         requestedAt: any;
-        status: 'pending' | 'accepted' | 'rejected' | 'cancelled';
+        status: SingleEditorStatus;
         editorAccessTimeout: number;
         tabId?: string | null;
     } | null;
@@ -56,7 +57,7 @@ export declare class EditorAccessTimer {
     /**
      * The time when the editor access was requested.
      */
-    state: 'idle' | 'inProgress' | 'completed';
+    state: SingleEditorState;
     /**
      * Duration left for the editor access timer to be completed.
      */

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

@@ -1,4 +1,4 @@
-import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, TagStatus, UserActionTypes } from "../../utils/enums";
+import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
 import { DocumentMetadata } from "./document-metadata.model";
 import { DocumentUser } from "./document-user.data.model";
 import { Location } from "./location.model";
@@ -19,7 +19,7 @@ export declare class NotificationRawData {
     /**
      * Source of a notification
      */
-    notificationSource?: 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
+    notificationSource?: NotificationSource;
     /**
      * Type of notification like 'Added', 'Updated' etc.
      */

package/app/models/data/organization-groups.data.model.d.ts

@@ -9,7 +9,7 @@ export declare class OrganizationUserGroup {
         [userIdHash: string]: boolean;
     };
 }
-export declare class ClientOrganizationUserGroup {
+export declare class UserGroup {
     groupId: string;
     groupName: string;
     users?: User[];

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

@@ -3,24 +3,24 @@ import { ReactionAnnotation } from "./reaction-annotation.data.model";
 import { ResolverResponse, ResolverConfig } from "./resolver.data.model";
 import { ResolverActions } from "../../utils/enums";
 export interface ReactionAnnotationDataProvider {
-    get: (request: GetReactionRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
-    save: (request: SaveReactionRequest) => Promise<ResolverResponse<undefined>>;
-    delete: (request: DeleteReactionRequest) => Promise<ResolverResponse<undefined>>;
+    get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
+    save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
+    delete: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
-export interface GetReactionRequest {
+export interface GetReactionResolverRequest {
     organizationId: string;
     reactionAnnotationIds?: string[];
     documentIds?: string[];
     folderId?: string;
     allDocuments?: boolean;
 }
-export interface DeleteReactionRequest {
+export interface DeleteReactionResolverRequest {
     reactionAnnotationId: string;
     metadata?: BaseMetadata;
     event?: ResolverActions;
 }
-export interface SaveReactionRequest {
+export interface SaveReactionResolverRequest {
     reactionAnnotation: {
         [key: string]: PartialReactionAnnotation;
     };

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

@@ -1,3 +1,4 @@
+import { RecorderFileFormat, RecorderLayoutMode, RecorderType } from "../../utils/enums";
 import { Attachment } from "./attachment.model";
 import { BaseMetadata } from "./base-metadata.data.model";
 import { CursorPosition } from "./cursor-position.data.model";
@@ -92,8 +93,8 @@ export declare class RecorderAnnotation {
      */
     location?: Location | null;
     type?: string;
-    recordingType: string;
-    mode: 'floating' | 'thread';
+    recordingType: RecorderType;
+    mode: RecorderLayoutMode;
     approved?: boolean;
     /**
      * Attachment object of recorded media
@@ -192,7 +193,7 @@ declare class RecorderDataAsset {
      * The format/extension of the file
      * @example 'mp3', 'mp4', 'webm'
      */
-    fileFormat?: 'mp3' | 'mp4' | 'webm' | string;
+    fileFormat?: RecorderFileFormat;
     thumbnailUrl?: string;
 }
 export declare class RecorderData {
@@ -205,4 +206,11 @@ export interface RecorderRequestQuery {
 export interface GetRecordingDataResponse {
     data: Record<string, RecorderData> | null;
 }
+export interface GetRecordingsResponse {
+    data: Record<string, RecorderAnnotationData> | null;
+}
+export declare class RecorderAnnotationData extends RecorderAnnotation {
+    transcriptionData: RecorderDataTranscription;
+    assets: RecorderDataAsset[];
+}
 export {};

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

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

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

@@ -1,4 +1,5 @@
 import { Observable } from "rxjs";
+import { RecorderType } from "../../utils/enums";
 export declare class RecorderConfig {
     type: {
         audio?: boolean;
@@ -26,7 +27,7 @@ export declare class RecorderInitData {
     /**
      * Type of media recorder, possible values are 'audio', 'video' and 'screen'
      */
-    type: 'audio' | 'video' | 'screen';
+    type: RecorderType;
     /**
      * Observable of recorded raw data.
      */
@@ -44,7 +45,7 @@ export declare class RecordedRawData {
     /**
      * Type of recorded data, possible values are 'audio' and 'video'
      */
-    type: 'audio' | 'video' | 'screen';
+    type: RecorderType;
     /**
      * Base64 encoded string of thumbnail image of one frame of recorded video
      */

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

@@ -1,13 +1,17 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse } from "../data/recorder-annotation.data.model";
+import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse, GetRecordingsResponse } from "../data/recorder-annotation.data.model";
 import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
+import { RecordedData } from "../data/recorder.model";
 
 export declare class RecorderElement {
 
     initRecording: (type: string, panelId?: string) => any;
 
-    onRecordedData: () => Observable<any>;
+    /**
+     * @deprecated Use on('recordingDone') method instead
+     */
+    onRecordedData: () => Observable<RecordedData | null>;
 
     /**
      * To enable recording countdown
@@ -55,10 +59,18 @@ export declare class RecorderElement {
      */
     disableVideoEditor: () => void;
 
+    /**
+     * To get recordings
+     */
+    getRecordings: (query?: RecorderRequestQuery) => Observable<GetRecordingsResponse>;
+
     constructor();
 
     private _initRecording;
 
+    /**
+     * @deprecated Use on('recordingDone') method instead
+     */
     private _onRecordedData;
 
     /**
@@ -106,4 +118,9 @@ export declare class RecorderElement {
      * To disable video editor
      */
     private _disableVideoEditor;
+
+    /**
+     * To get recordings
+     */
+    private _getRecordings;
 }

package/app/utils/enums.d.ts

@@ -55,9 +55,14 @@ export declare const CommentEventTypes: {
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";
+    readonly RECORDING_DONE: "recordingDone";
+    readonly DELETE_RECORDING: "deleteRecording";
 };
 export declare const CoreEventTypes: {
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
+    readonly USER_UPDATE: "userUpdate";
+    readonly DOCUMENT_INIT: "documentInit";
+    readonly ERROR: "error";
 };
 export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
 export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
@@ -177,3 +182,41 @@ export declare enum ContactListScopeForOrganizationUsers {
     DOCUMENT = "document",
     FOLDER = "folder"
 }
+export type RecorderMode = 'audio' | 'video' | 'screen' | 'all' | string;
+export type RecorderType = 'audio' | 'video' | 'screen';
+export type RecorderFileFormat = 'mp3' | 'mp4' | 'webm';
+export type RecorderLayoutMode = 'floating' | 'thread';
+export type SupportedMimeType = 'audio' | 'video';
+export type FirebaseRegion = 'usCentral1' | 'asiaSouthEast1' | 'europeWest1';
+export type VideoEventType = 'play' | 'pause' | 'ratechange' | 'seeked' | 'timeupdate' | 'volumechange';
+export type RewriterType = 'copywriter' | 'generic';
+export type RecorderStatusType = 'started' | 'paused' | 'resumed' | 'stopped' | 'error' | null;
+export type HuddleType = 'audio' | 'video' | 'presentation';
+export type NotificationTabId = 'for-you' | 'all' | 'document' | 'people';
+export type NotificationTabType = 'forYou' | 'all' | 'documents' | 'people';
+export type NotificationSource = 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
+export type SingleEditorStatus = 'pending' | 'accepted' | 'rejected' | 'cancelled';
+export type SingleEditorState = 'idle' | 'inProgress' | 'completed';
+export type AudioWaveformVariant = 'expanded' | 'minified' | 'player' | 'preview' | 'preview-mini' | 'editor';
+export type ActionButtonType = 'button' | 'button-toggle' | 'multi-select' | 'single-select';
+export type DropdownPosition = 'left' | 'right' | 'center';
+export type DevicePermissionType = 'audio' | 'video';
+export type TranscriptionMode = 'floating' | 'embed' | 'summaryMode';
+export type ComposerPosition = 'top' | 'bottom';
+export type SortBy = 'lastUpdated' | 'createdAt';
+export type SortOrder = 'asc' | 'desc';
+export type MinimapPosition = 'left' | 'right';
+export type FilterOptionLayout = 'dropdown' | 'checkbox';
+export type FilterPanelPosition = 'menu' | 'bottomSheet';
+export type OverlayOriginY = 'top' | 'center' | 'bottom';
+export type OverlayOriginX = 'start' | 'center' | 'end';
+export type SubtitlesMode = 'floating' | 'embed';
+export type RecorderVariant = 'default' | 'embed';
+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 InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
+export type NotificationPanelMode = 'popover' | 'sidebar';
+export type SidebarActionButtonType = 'default' | 'toggle';

package/models.d.ts

@@ -9,6 +9,7 @@ export * from './app/models/data/comment-annotation.data.model';
 export * from './app/models/data/comment-events.data.model';
 export * from './app/models/data/comment.data.model';
 export * from './app/models/data/comment-actions.data.model';
+export * from './app/models/data/comment-resolver.data.model';
 export * from './app/models/data/comment-utils.data.model';
 export * from './app/models/data/contact-utils.data.model';
 export * from './app/models/data/config.data.model';
@@ -62,6 +63,7 @@ export * from './app/models/data/comment-sidebar-config.model';
 export * from './app/models/data/views.data.model';
 export * from './app/models/data/autocomplete.data.model';
 export * from './app/models/data/reaction-annotation.data.model';
+export * from './app/models/data/reaction-resolver.data.model';
 export * from './app/models/data/reaction.data.model';
 export * from './app/models/data/organization-groups.data.model';
 export * from './app/models/data/organization-metadata.model';
@@ -69,3 +71,4 @@ export * from './app/models/data/user-organization.data.model';
 export * from './app/models/data/event-metadata.data.model';
 export * from './app/models/data/user-resolver.data.model';
 export * from './app/models/data/provider.data.model';
+export * from './app/models/data/resolver.data.model';

package/package.json

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