@veltdev/types-dev 4.5.0-beta.99 → 4.5.2-beta.10

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

@@ -3,7 +3,7 @@ import { Observable } from "rxjs";
 import { Config, DisableLogsConfig } from "../models/data/config.data.model";
 import { DocumentUser } from "../models/data/document-user.data.model";
 import { Location } from "../models/data/location.model";
-import { User, UserOptions } from "../models/data/user.data.model";
+import { User, UserOptions, VeltAuthProvider } from "../models/data/user.data.model";
 import { CustomCss } from "../models/data/custom-css.data.model";
 import { AreaElement } from "../models/element/area-element.model";
 import { ArrowElement } from "../models/element/arrow-element.model";
@@ -24,12 +24,14 @@ import { FeatureType } from "../utils/enums";
 import { UserContact } from "../models/data/user-contact.data.model";
 import { DocumentMetadata } from "../models/data/document-metadata.model";
 import { ReactionElement } from "../models/element/reaction-element.model";
+import { CrdtElement } from "../models/element/crdt-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, UpdateDocumentsRequest, UpdateLocationsRequest } 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 { VeltDataProvider } from "../models/data/provider.data.model";
+import { VeltEncryptionProvider } from "../models/data/encryption-provider.data.model";
 import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
 import { SetLocationsRequestOptions } from "../models/data/location.model";
 
@@ -37,6 +39,7 @@ export declare class Snippyly {
    constructor();
    initConfig: (apiKey: string, config?: Config) => void;
    identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
+   setVeltAuthProvider: (veltAuthProvider: VeltAuthProvider) => Promise<User | null>;
    /**
     * Tell us who the currently logged in user is.
     *
@@ -97,6 +100,10 @@ export declare class Snippyly {
     * To set the data provider.
     */
    setDataProviders: (dataProvider: VeltDataProvider) => void;
+   /**
+    * To set the encryption provider.
+    */
+   setEncryptionProvider: (encryptionProvider: VeltEncryptionProvider) => void;
    /**
     * Get Document ID
     */
@@ -225,6 +232,10 @@ export declare class Snippyly {
     * Get the Area Object.
     */
    getReactionElement: () => ReactionElement;
+   /**
+    * Get the CRDT Element Object.
+    */
+   getCrdtElement: () => CrdtElement;
    /**
     * Get the metadata of the current resource.
     */
@@ -345,8 +356,18 @@ export declare class Snippyly {
     */
    disableLogs: (config?: DisableLogsConfig) => void;
 
+   /**
+   * To enable safe eval.
+   */
+   enableSafeEval: () => void;
+
+   /**
+    * To disable safe eval.
+    */
+   disableSafeEval: () => void;
+
    /**
     * To reset the button toggle map.
     */
    resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
-}
+}

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

@@ -8,6 +8,7 @@ export declare class AutocompleteData {
     description?: string;
     type: 'custom' | 'contact' | 'group';
     data: AutocompleteItem[];
+    groups?: AutocompleteGroup[];
 }
 export declare class AutocompleteItem {
     id: string;
@@ -18,6 +19,7 @@ export declare class AutocompleteItem {
         svg?: string;
     };
     link?: string;
+    groupId?: string;
 }
 export declare class AutocompleteReplaceData {
     text: string;
@@ -34,6 +36,10 @@ export declare class AutocompleteUserContactReplaceData {
     userId: string;
     contact?: UserContact;
 }
+export declare class AutocompleteGroup {
+    id: string;
+    name: string;
+}
 export declare class AutocompleteChipData extends AutocompleteItem {
     type: 'contact' | 'custom';
 }

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

@@ -45,6 +45,10 @@ export interface AddCommentAnnotationRequest {
     annotation: CommentAnnotation;
     options?: RequestOptions;
 }
+export interface PublishCommentAnnotationRequest {
+    annotationId: string;
+    options?: RequestOptions;
+}
 export interface ApproveCommentAnnotationRequest {
     annotationId: string;
     options?: RequestOptions;
@@ -62,12 +66,15 @@ export interface DeleteCommentAnnotationRequest {
     options?: RequestOptions;
 }
 export interface CommentRequestQuery {
+    organizationId?: string;
     documentIds?: string[];
     locationIds?: string[];
     statusIds?: string[];
     folderId?: string;
     allDocuments?: boolean;
     locationId?: string;
+    aggregateDocuments?: boolean;
+    filterGhostComments?: boolean;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;

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

@@ -9,6 +9,7 @@ import { PageInfo } from "./page-info.model";
 import { TargetElement } from "./target-element.data.model";
 import { TargetTextRange } from "./target-text-range.data.model";
 import { User } from "./user.data.model";
+import { CommentAnnotationViews } from "./views.data.model";
 export declare class CommentAnnotation {
     /**
      * Unique identifier for the comment pin annotation.
@@ -180,6 +181,8 @@ export declare class CommentAnnotation {
     multiThreadAnnotationId?: string;
     isDraft?: boolean;
     sourceId?: string;
+    views?: CommentAnnotationViews;
+    viewedByUserIds?: string[];
 }
 export declare class GhostComment {
     targetElement?: TargetElement | null;

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

@@ -102,6 +102,11 @@ export interface AddCommentAnnotationEvent {
         xpath: string;
     };
 }
+export interface PublishCommentAnnotationEvent {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+}
 export interface ApproveCommentAnnotationEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;

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

@@ -29,6 +29,14 @@ export interface SaveCommentResolverRequest {
     metadata?: BaseMetadata;
     commentId?: string;
 }
+export interface PartialUser {
+    userId: string;
+}
+export interface PartialTaggedUserContacts {
+    userId: string;
+    contact?: PartialUser;
+    text?: string;
+}
 export interface PartialComment {
     commentId: string | number;
     commentHtml?: string;
@@ -36,6 +44,9 @@ export interface PartialComment {
     attachments?: {
         [attachmentId: number]: PartialAttachment;
     };
+    from?: PartialUser;
+    to?: PartialUser[];
+    taggedUserContacts?: PartialTaggedUserContacts[];
 }
 export interface PartialCommentAnnotationResult {
     strippedData: {
@@ -44,10 +55,18 @@ export interface PartialCommentAnnotationResult {
     originalData: CommentAnnotation | null;
     eventType?: ResolverActions;
 }
+export interface PartialTargetTextRange {
+    text: string;
+}
 export interface PartialCommentAnnotation {
     annotationId: string;
     metadata?: BaseMetadata;
     comments: {
         [commentId: string]: PartialComment;
     };
+    from?: PartialUser;
+    assignedTo?: PartialUser;
+    targetTextRange?: PartialTargetTextRange;
+    resolvedByUserId?: string | null;
+    [key: string]: any;
 }

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

@@ -23,6 +23,7 @@ export declare class CommentSidebarFilterConfig {
     people?: FilterTypeConfig;
     assigned?: FilterTypeConfig;
     tagged?: FilterTypeConfig;
+    involved?: FilterTypeConfig;
     priority?: FilterTypeConfig;
     status?: FilterTypeConfig;
     category?: FilterTypeConfig;
@@ -55,6 +56,11 @@ export declare class CommentSidebarFilters {
         email?: string;
         name?: string;
     }[];
+    involved?: {
+        userId?: string;
+        email?: string;
+        name?: string;
+    }[];
     priority?: string[];
     status?: string[];
     category?: string[];

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

@@ -9,6 +9,7 @@ export declare class Comment {
      * Auto generated.
      */
     commentId: number;
+    context?: any;
     /**
      * This determines the comment content type.
      *

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

@@ -11,8 +11,10 @@ export type CoreEventTypesMap = {
 export type UserUpdateEvent = User | null;
 export type DocumentInitEvent = boolean | undefined;
 export type ErrorEvent = {
+    error?: string;
     code: string;
     message?: string;
+    source?: string;
 };
 export type InitUpdateEvent = {
     event: string;

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

@@ -0,0 +1,59 @@
+export interface CrdtVersion {
+    versionId: string;
+    versionName?: string;
+    state: Uint8Array | number[];
+    timestamp: number;
+}
+export interface CrdtVersionWithEncryptedState extends Omit<CrdtVersion, 'state'> {
+    encryptedState: string;
+}
+export interface CrdtUpdateDataQuery {
+    id: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtOnDataChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtGetDataQuery {
+    id: string;
+}
+export interface CrdtOnStateChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtUpdateStateQuery {
+    id: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtRegisterSyncUserQuery {
+    id: string;
+}
+export interface CrdtOnRegisteredUserChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtSetPresenceQuery {
+    id: string;
+}
+export interface CrdtOnPresenceChangeQuery {
+    id: string;
+    callback: (data: any) => void;
+}
+export interface CrdtSaveVersionQuery {
+    id: string;
+    versionId: string;
+    versionName?: string;
+    state: Uint8Array | number[];
+}
+export interface CrdtGetVersionQuery {
+    id: string;
+    versionId: string;
+}
+export interface CrdtGetVersionsQuery {
+    id: string;
+}
+export interface CrdtDeleteVersionQuery {
+    id: string;
+    versionId: string;
+}

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

@@ -7,6 +7,7 @@ export declare class DocumentPaths {
     locationId?: string;
     allDocuments?: boolean;
     veltFolderId?: string;
+    folder?: string;
     /**
      * Presence path.
      */
@@ -72,6 +73,10 @@ export declare class DocumentPaths {
      * User login path.
      */
     logins?: string;
+    /**
+     * CRDT path.
+     */
+    crdt?: string;
     /**
      * Selection path.
      */

package/app/models/data/encryption-provider.data.model.d.ts

@@ -0,0 +1,12 @@
+export interface EncryptConfig<T = any> {
+    data: T;
+    type?: string;
+}
+export interface DecryptConfig<R = any> {
+    data: R;
+    type?: string;
+}
+export interface VeltEncryptionProvider<T = any, R = any> {
+    encrypt: (config: EncryptConfig<T>) => Promise<R>;
+    decrypt: (config: DecryptConfig<R>) => Promise<T>;
+}

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

@@ -1,4 +1,5 @@
 import { SingleEditorState, SingleEditorStatus } from "../../utils/enums";
+import { ErrorEvent } from "./core-events.data.model";
 import { User } from "./user.data.model";
 export declare class LiveStateData {
     /**
@@ -72,3 +73,20 @@ export declare class EditorAccessTimer {
 export declare class LiveStateDataConfig {
     listenToNewChangesOnly?: boolean;
 }
+export interface SetUserAsEditorResponse {
+    error?: ErrorEvent;
+}
+export interface LiveStateSingleEditorExternalUserPresence {
+    /**
+     * True if the same user is present on different tab.
+     */
+    sameUserPresentOnTab?: boolean;
+    /**
+     * True if the different user is present on different tab.
+     */
+    differentUserPresentOnTab?: boolean;
+    /**
+     * User ids of the users present on different tab.
+     */
+    userIds?: string[];
+}

package/app/models/data/media-preview-config.data.model.d.ts

@@ -2,11 +2,13 @@ export declare class MediaPreviewConfig {
     audio?: {
         enabled?: boolean;
         deviceId?: string;
+        stream?: MediaStream;
     };
     video?: {
         enabled?: boolean;
         deviceId?: string;
         track?: MediaStreamTrack;
+        stream?: MediaStream;
     };
     screen?: {
         enabled?: boolean;

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

@@ -249,3 +249,6 @@ export interface NotificationsDocConfig {
     email: 'ALL' | 'NONE' | 'MINE';
     [key: string]: string;
 }
+export interface GetNotificationsDataQuery {
+    type?: 'all' | 'forYou' | 'documents';
+}

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

@@ -1,7 +1,8 @@
+import { ResolverActions } from "../../utils/enums";
 import { BaseMetadata } from "./base-metadata.data.model";
+import { PartialUser } from "./comment-resolver.data.model";
 import { ReactionAnnotation } from "./reaction-annotation.data.model";
-import { ResolverResponse, ResolverConfig } from "./resolver.data.model";
-import { ResolverActions } from "../../utils/enums";
+import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface ReactionAnnotationDataProvider {
     get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
     save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
@@ -37,4 +38,5 @@ export interface PartialReactionAnnotation {
     annotationId: string;
     metadata?: BaseMetadata;
     icon?: string;
+    from?: PartialUser;
 }

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

@@ -8,10 +8,24 @@ export interface RecordingDeleteEvent extends RecorderData {
 }
 export interface RecordingEditDoneEvent extends RecorderData {
 }
+export interface RecordingActionsEvent {
+    type: 'audio' | 'video' | 'screen';
+}
+export interface RecordingStartedEvent extends RecordingActionsEvent {
+}
+export interface RecordingPausedEvent extends RecordingActionsEvent {
+}
+export interface RecordingCancelledEvent extends RecordingActionsEvent {
+}
+export interface RecordingStoppedEvent extends RecordingActionsEvent {
+}
+export interface RecordingResumedEvent extends RecordingActionsEvent {
+}
 export interface RecordingErrorEvent {
     type: string;
     message: string;
     recorderId?: string;
+    url?: string;
 }
 export interface RecordingSaveInitiatedEvent {
     annotationId?: string;
@@ -23,4 +37,9 @@ export type RecorderEventTypesMap = {
     [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;
     [RecorderEventTypes.RECORDING_EDIT_DONE]: RecordingEditDoneEvent;
     [RecorderEventTypes.DELETE_RECORDING]: RecordingDeleteEvent;
+    [RecorderEventTypes.RECORDING_STARTED]: RecordingStartedEvent;
+    [RecorderEventTypes.RECORDING_PAUSED]: RecordingPausedEvent;
+    [RecorderEventTypes.RECORDING_CANCELLED]: RecordingCancelledEvent;
+    [RecorderEventTypes.RECORDING_STOPPED]: RecordingStoppedEvent;
+    [RecorderEventTypes.RECORDING_RESUMED]: RecordingResumedEvent;
 };

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

@@ -105,3 +105,7 @@ export declare class RecorderEncodingOptions {
     safari?: MediaRecorderOptions;
     other?: MediaRecorderOptions;
 }
+export declare class RecorderDevicePermissionOptions {
+    audio?: boolean;
+    video?: boolean;
+}

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

@@ -4,6 +4,7 @@ export interface ResolverConfig {
     deleteRetryConfig?: RetryConfig;
     getRetryConfig?: RetryConfig;
     resolveUsersConfig?: ResolveUsersConfig;
+    fieldsToRemove?: string[];
 }
 export interface ResolveUsersConfig {
     organization?: boolean;

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

@@ -11,6 +11,12 @@ export declare class UserIAM {
      * The user's contact details
      */
     user: UserContact;
+    documentIds?: string[];
+    folderIds?: string[];
+    organizationIds?: string[];
+    documentIdsCount?: number;
+    folderIdsCount?: number;
+    organizationIdsCount?: number;
     /**
      * The user's role in the document
      */

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

@@ -99,3 +99,13 @@ export declare class Options {
      */
     forceReset?: boolean;
 }
+export interface AuthRetryConfig {
+    retryCount?: number;
+    retryDelay?: number;
+}
+export interface VeltAuthProvider {
+    user: User;
+    options?: Options;
+    retryConfig?: AuthRetryConfig;
+    generateToken?: () => Promise<string>;
+}