@veltdev/types 4.7.1 → 4.7.2

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

@@ -1,4 +1,4 @@
-import { AreaStatus, ArrowStatus, CommentStatus, CrdtActionTypes, HuddleActionTypes, NotificationSettingsItemType, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
+import { AreaStatus, ArrowStatus, CommentStatus, TagStatus, UserActionTypes } from "../../utils/enums";
 import { DocumentMetadata } from "./document-metadata.model";
 import { DocumentUser } from "./document-user.data.model";
 import { Location } from "./location.model";
@@ -19,11 +19,11 @@ export declare class NotificationRawData {
     /**
      * Source of a notification
      */
-    notificationSource?: NotificationSource;
+    notificationSource?: 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
     /**
      * Type of notification like 'Added', 'Updated' etc.
      */
-    actionType?: AreaStatus | ArrowStatus | CommentStatus | TagStatus | UserActionTypes | HuddleActionTypes | CrdtActionTypes;
+    actionType?: AreaStatus | ArrowStatus | CommentStatus | TagStatus | UserActionTypes;
     /**
      * Annotation object
      */
@@ -39,8 +39,6 @@ export declare class NotificationRawData {
     newStatus?: string;
     metadata?: DocumentMetadata & {
         apiKey?: string;
-        clientOrganizationId?: string;
-        organizationId?: string;
     } | null;
     documentUser?: DocumentUser;
     oldAccess?: string;
@@ -67,8 +65,6 @@ export declare class NotificationRawData {
         commenter?: {
             clientDocumentId: string;
             documentId: string;
-            clientOrganizationId?: string;
-            organizationId?: string;
             emails: string[];
             emailProperties: {
                 url?: string;
@@ -88,17 +84,10 @@ export declare class NotificationRawData {
         [key: string]: any;
     };
     displayBodyMessage?: string;
-    displayBodyMessageTemplate?: string;
-    displayBodyMessageTemplateData?: {
-        users?: User[];
-        [key: string]: any;
-    };
     customData?: any;
     notifyUsers?: {
         [email: string]: boolean;
     };
-    crdtData?: unknown;
-    notificationSourceData?: any;
 }
 export declare class Notification {
     /**
@@ -133,123 +122,8 @@ export declare class Notification {
      * Notification body message
      */
     displayBodyMessage?: string;
-    /**
-     * Is comment text available
-     */
-    isCommentResolverUsed?: boolean;
-    /**
-     * Display body message template
-       */
-    displayBodyMessageTemplate?: string;
-    /**
-     * Display body message template data
-     */
-    displayBodyMessageTemplateData?: {
-        users?: User[];
-        [key: string]: any;
-    };
-    /**
-     * Display message template
-     */
-    displayHeadlineMessageTemplate?: string;
-    /**
-     * Display message template data
-     */
-    displayHeadlineMessageTemplateData?: {
-        actionUser: User;
-        recipientUser: User;
-        actionMessage: string;
-        project: string;
-        [key: string]: any;
-    };
     /**
      * Is notification for you
      */
     forYou?: boolean;
-    /**
-     * Notification annotation target
-     */
-    targetAnnotationId?: string;
-    /**
-     * Notification annotation data
-     */
-    notificationSourceData?: any;
-    /**
-     * Notification metadata
-     */
-    metadata?: NotificationMetadata;
-    /**
-     * Notification notify users map by email hash
-     */
-    notifyUsers?: {
-        [email: string]: boolean;
-    };
-    /**
-     * Notification notify users map by user id hash
-     */
-    notifyUsersByUserId?: {
-        [userId: string]: boolean;
-    };
-}
-export declare class NotificationMetadata {
-    /**
-     * API Key
-     */
-    apiKey?: string;
-    /**
-     * Client organization ID
-     */
-    clientOrganizationId?: string;
-    /**
-     * Organization ID
-     */
-    organizationId?: string;
-    /**
-     * Client document ID
-     */
-    clientDocumentId?: string | number;
-    /**
-     * Document ID
-     */
-    documentId?: string;
-    /**
-     * Location ID
-     */
-    locationId?: number;
-    /**
-     * Location object
-     */
-    location?: Location;
-}
-export declare class NotificationTabConfigItem {
-    name?: string;
-    enable?: boolean;
-}
-export declare class NotificationTabConfig {
-    forYou?: NotificationTabConfigItem;
-    documents?: NotificationTabConfigItem;
-    all?: NotificationTabConfigItem;
-    people?: NotificationTabConfigItem;
-}
-export declare class NotificationInitialSettingsConfig {
-    name?: string;
-    id: string;
-    default?: string;
-    enable?: boolean;
-    values?: NotificationConfigValue[];
-}
-export declare class NotificationConfigValue {
-    name?: string;
-    id: NotificationSettingsItemType;
-}
-export declare class NotificationSettingsConfig {
-    [key: string]: NotificationSettingsItemType;
-}
-export interface NotificationsDocConfig {
-    inbox: 'ALL' | 'NONE' | 'MINE';
-    email: 'ALL' | 'NONE' | 'MINE';
-    [key: string]: string;
-}
-export interface GetNotificationsDataQuery {
-    type?: 'all' | 'forYou' | 'documents';
 }

package/app/models/data/page-info.model.d.ts

@@ -8,10 +8,6 @@ export declare class PageInfo {
      * Path of the webpage excluding base url
      */
     path?: string;
-    /**
-     * Query parameters of the webpage
-     */
-    queryParams?: string;
     /**
      * Base URL (domain) of a webpage
      */

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

@@ -38,10 +38,6 @@ export declare class PresenceUser {
      * This is the color on the avatar border and live cursor, if these features are enabled.
      */
     color?: string;
-    /**
-    * This is the color on the avatar text.
-    */
-    textColor?: string;
     /**
      * Server Timestamp.
      *
@@ -80,7 +76,4 @@ export declare class PresenceUser {
      */
     isAnonymous?: boolean;
     pageInfo: PageInfo;
-    initial?: string;
-    isTabAway?: boolean;
-    isUserIdle?: boolean;
 }

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

@@ -1,24 +1,18 @@
-import { RecorderFileFormat, RecorderLayoutMode, RecorderType } from "../../utils/enums";
+import { RecorderBoundedScaleRange } from "src/models";
 import { Attachment } from "./attachment.model";
-import { BaseMetadata } from "./base-metadata.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 { Transcription } from "./transcription.data.model";
-import { Context, User } from "./user.data.model";
+import { User } from "./user.data.model";
 export declare class RecorderAnnotation {
-    context?: Context;
     /**
      * Unique identifier for the recorder pin annotation.
      *
      * Auto generated.
      */
     annotationId: string;
-    /**
-       * Connected comment annotation id of reaction annotation
-       */
-    commentAnnotationId?: string;
     /**
      * The user who created this recorder pin annotation.
      *
@@ -94,8 +88,8 @@ export declare class RecorderAnnotation {
      */
     location?: Location | null;
     type?: string;
-    recordingType: RecorderType;
-    mode: RecorderLayoutMode;
+    recordingType: string;
+    mode: 'floating' | 'thread';
     approved?: boolean;
     /**
      * Attachment object of recorded media
@@ -124,116 +118,30 @@ export declare class RecorderAnnotation {
      * Transcription of the recorded media
      */
     transcription?: Transcription;
-    /**
-     * Waveform data for the annotation
-     */
-    waveformData?: number[];
-    /**
-     * Display name for the annotation
-     */
-    displayName?: string;
-    metadata?: RecorderMetadata;
     /**
      * Current version of the recording edit
      */
     latestVersion?: number;
     /**
      * History of all editing versions of this recording
-     * Maps version number to version data
      */
-    recordingEditVersions?: {
-        [key: number]: RecorderAnnotationEditVersion;
-    };
-    /**
-     * URLs for individual uploaded chunks
-     */
-    chunkUrls?: {
-        [key: number]: string;
-    };
+    recordingEditVersions?: { [key: number]: RecorderAnnotationEditVersion };
 }
+
 export interface RecorderAnnotationEditVersion {
     from?: User;
     createdAt?: Date;
     attachment?: Attachment | null;
     attachments?: Attachment[];
-    recordedTime?: {
-        duration?: number;
-        display?: string;
-    } | null;
+    recordedTime?: { duration?: number, display?: string } | null;
     transcription?: Transcription;
     waveformData?: number[];
     displayName?: string;
     boundedTrimRanges?: RecorderBoundedTrimRange[];
     boundedScaleRanges?: RecorderBoundedScaleRange[];
 }
+
 export interface RecorderBoundedTrimRange {
     start: number;
     end: number;
-}
-export interface RecorderBoundedScaleRange {
-    start: number;
-    end: number;
-    zoomInDuration?: number;
-    holdDuration?: number;
-    zoomOutDuration?: number;
-    zoomFactor?: number;
-    centerX?: number;
-    centerY?: number;
-    topLeftX?: number;
-    topLeftY?: number;
-    topLeftXPixels?: number;
-    topLeftYPixels?: number;
-}
-export interface RecorderEditRange {
-    trimRanges: RecorderBoundedTrimRange[];
-    scaleRanges: RecorderBoundedScaleRange[];
-}
-export declare class RecorderMetadata extends BaseMetadata {
-    [key: string]: any;
-}
-declare class RecorderDataTranscriptSegment {
-    startTime: string;
-    endTime: string;
-    startTimeInSeconds: number;
-    endTimeInSeconds: number;
-    text: string;
-}
-declare class RecorderDataTranscription {
-    transcriptSegments?: RecorderDataTranscriptSegment[];
-    vttFileUrl?: string;
-    contentSummary?: string;
-}
-declare class RecorderDataAsset {
-    version?: number;
-    url: string;
-    mimeType?: string;
-    fileName?: string;
-    /** File size in bytes */
-    fileSizeInBytes?: number;
-    /**
-     * The format/extension of the file
-     * @example 'mp3', 'mp4', 'webm'
-     */
-    fileFormat?: RecorderFileFormat;
-    thumbnailUrl?: string;
-    transcription: RecorderDataTranscription;
-}
-export declare class RecorderData {
-    recorderId: string;
-    from?: User | null;
-    metadata?: RecorderMetadata;
-    assets: RecorderDataAsset[];
-    assetsAllVersions: RecorderDataAsset[];
-    transcription: RecorderDataTranscription;
-}
-export interface RecorderRequestQuery {
-    recorderIds: string[];
-}
-export interface GetRecordingDataResponse {
-    data: Record<string, RecorderData> | null;
-}
-export interface GetRecordingsResponse extends RecorderData {
-}
-export interface DeleteRecordingsResponse extends RecorderData {
-}
-export {};
+}

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

@@ -1,5 +1,4 @@
 import { Observable } from "rxjs";
-import { RecorderType } from "../../utils/enums";
 export declare class RecorderConfig {
     type: {
         audio?: boolean;
@@ -27,7 +26,7 @@ export declare class RecorderInitData {
     /**
      * Type of media recorder, possible values are 'audio', 'video' and 'screen'
      */
-    type: RecorderType;
+    type: 'audio' | 'video' | 'screen';
     /**
      * Observable of recorded raw data.
      */
@@ -45,7 +44,7 @@ export declare class RecordedRawData {
     /**
      * Type of recorded data, possible values are 'audio' and 'video'
      */
-    type: RecorderType;
+    type: 'audio' | 'video' | 'screen';
     /**
      * Base64 encoded string of thumbnail image of one frame of recorded video
      */
@@ -57,12 +56,6 @@ export declare class RecordedRawData {
         duration?: number;
         display?: string;
     } | null;
-    /**
-     * Array of URLs for individual uploaded chunks
-     */
-    chunkUrls?: {
-        [key: number]: string;
-    };
 }
 export declare class RecordedData {
     /**
@@ -85,27 +78,5 @@ export declare class RecordedData {
      * URL of the hosted website to open video in new tab
      */
     videoPlayerUrl?: string;
-    /**
-     * URLs for individual uploaded chunks
-     */
-    chunkUrls?: {
-        [key: number]: string;
-    };
     getThumbnailTag: (url?: string) => string;
 }
-export declare class RecorderQualityConstraintsOptions {
-    video?: MediaTrackConstraints;
-    audio?: MediaTrackConstraints;
-}
-export declare class RecorderQualityConstraints {
-    safari?: RecorderQualityConstraintsOptions;
-    other?: RecorderQualityConstraintsOptions;
-}
-export declare class RecorderEncodingOptions {
-    safari?: MediaRecorderOptions;
-    other?: MediaRecorderOptions;
-}
-export declare class RecorderDevicePermissionOptions {
-    audio?: boolean;
-    video?: boolean;
-}

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

@@ -19,16 +19,4 @@ export declare class Selection {
      */
     targetTextRange?: TargetTextRange | null;
     pageInfo: PageInfo;
-    timestamp: number;
-}
-export declare enum UserIndicatorPosition {
-    Start = "start",
-    End = "end"
-}
-export declare enum UserIndicatorType {
-    Avatar = "avatar",
-    Label = "label"
-}
-export declare class LiveSelectionData {
-    [userIdHash: string]: Selection;
 }

package/app/models/data/target-element.data.model.d.ts

@@ -1,4 +1,3 @@
-import { AnchorRecord } from './anchor-record.data.model';
 export declare class TargetElement {
     /**
      * Xpath of target element
@@ -20,8 +19,4 @@ export declare class TargetElement {
      * Relative left position of cursor on target element
      */
     leftPercentage: number;
-    /**
-     * Robust anchor descriptor for the element
-     */
-    anchor?: AnchorRecord | null;
 }

package/app/models/data/target-text-range.data.model.d.ts

@@ -1,21 +1,8 @@
-import { AnchorRecord } from "./anchor-record.data.model";
 export declare class TargetTextRange {
     /**
      * Xpath of common Ancestor Container
      */
     commonAncestorContainer?: string;
-    /**
-     * Full xpath of common Ancestor Container
-     */
-    commonAncestorContainerFXpath?: string;
-    /**
-     * Full xpath of common Ancestor Container with class names
-     */
-    commonAncestorContainerCFXpath?: string;
-    /**
-     * Anchor of common Ancestor Container
-     */
-    commonAncestorContainerAnchor?: AnchorRecord;
     /**
      * Selected text
      */

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

@@ -26,25 +26,4 @@ export declare class UserContact {
     groupId?: string;
     source?: string;
     visibility: 'group' | 'private';
-    color?: string;
-    textColor?: string;
-    initial?: string;
-}
-export declare class SelectedUserContact {
-    /**
-     * Selected user contact details.
-     */
-    contact: UserContact;
-    /**
-     * Is user part of organization contact.
-     */
-    isOrganizationContact: boolean;
-    /**
-     * Is user part of document contact.
-     */
-    isDocumentContact: boolean;
-    /**
-     * Document access type.
-     */
-    documentAccessType: string;
 }

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

@@ -1,4 +1,3 @@
-import { BaseMetadata } from "./base-metadata.data.model";
 import { UserContact } from "./user-contact.data.model";
 import { UserRole } from "./user-role.data.model";
 import { User } from "./user.data.model";
@@ -11,16 +10,6 @@ export declare class UserIAM {
      * The user's contact details
      */
     user: UserContact;
-    accessFields?: string[];
-    documentIds?: string[];
-    viewerDocumentIds?: string[];
-    folderIds?: string[];
-    viewerFolderIds?: string[];
-    organizationIds?: string[];
-    viewerOrganizationIds?: string[];
-    documentIdsCount?: number;
-    folderIdsCount?: number;
-    organizationIdsCount?: number;
     /**
      * The user's role in the document
      */
@@ -41,8 +30,4 @@ export declare class UserIAM {
      * Date when this user was updated
      */
     updatedDate?: any;
-    groups?: {
-        [groupId: string]: boolean;
-    };
-    metadata?: BaseMetadata;
 }

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

@@ -1,6 +1,4 @@
-import { SetDocumentsContext } from "./document.data.model";
 import { UserContact } from "./user-contact.data.model";
-import { UserPermissionAccessRole } from "./user-resolver.data.model";
 export declare class User {
     /**
      * Unique user identifier that you use to identify your user.
@@ -12,7 +10,6 @@ export declare class User {
      * Default: Random avatar name.
      */
     name?: string;
-    clientUserName?: string;
     /**
     * Your user's display picture URL.
     *
@@ -40,8 +37,6 @@ export declare class User {
      * Original groupId provided by the user.
      */
     clientGroupId?: string;
-    organizationId?: string;
-    clientOrganizationId?: string;
     /**
      * Auto generated unique user id that is linked with your app's user ID.
      * This is needed by us for internal processing.
@@ -52,10 +47,6 @@ export declare class User {
      * This is the color on the avatar border and live cursor, if these features are enabled.
      */
     color?: string;
-    /**
-     * This is the color on the avatar text.
-     */
-    textColor?: string;
     /**
      * User type.
      *
@@ -74,7 +65,6 @@ export declare class User {
      * Guest user
      */
     isGuest?: boolean;
-    initial?: string;
 }
 export declare class Options {
     /**
@@ -96,76 +86,4 @@ export declare class Options {
      * Pass the auth token of the user.
      */
     authToken?: string;
-    /**
-     * If you want to force re-login the user.
-     */
-    forceReset?: boolean;
-    /**
-     * If you want to throw an error if the user is not authenticated.
-     */
-    throwError?: boolean;
-}
-export interface AuthRetryConfig {
-    retryCount?: number;
-    retryDelay?: number;
-}
-export interface Context {
-    access: {
-        [key: string]: string | number;
-    };
-    accessFields?: Array<string>;
-}
-export interface VeltAuthProvider {
-    user: User;
-    options?: Options;
-    retryConfig?: AuthRetryConfig;
-    generateToken?: () => Promise<string>;
-    onError?: (err: unknown) => void;
-}
-export declare enum RevokeAccessOnType {
-    DOCUMENT_UNSET = "document_unset",
-    USER_LOGOUT = "user_logout"
-}
-export declare enum PermissionSource {
-    SET_DOCUMENTS = "setDocuments",
-    IDENTIFY = "identify",
-    GET_NOTIFICATIONS = "getNotifications",
-    SET_NOTIFICATIONS = "setNotifications",
-    REVOKE_ACCESS_ON_USER_LOGOUT = "revokeAccessOnUserLogout",
-    REVOKE_ACCESS_ON_DOCUMENT_UNSET = "revokeAccessOnDocumentUnset"
-}
-export interface RevokeAccessOn {
-    type: RevokeAccessOnType;
-    revokeOrganizationAccess?: boolean;
-}
-export interface VeltPermissionProvider {
-    retryConfig?: AuthRetryConfig;
-    isContextEnabled?: boolean;
-    revokeAccessOn?: RevokeAccessOn[];
-    forceRefresh?: boolean;
-}
-export declare enum PermissionResourceType {
-    FOLDER = "folder",
-    DOCUMENT = "document",
-    ORGANIZATION = "organization",
-    CONTEXT = "context"
-}
-export interface PermissionQuery {
-    userId: string;
-    resource: {
-        id: string;
-        type: PermissionResourceType;
-        source: PermissionSource;
-        organizationId: string;
-        context?: Context | SetDocumentsContext;
-    };
-}
-export interface PermissionResult {
-    userId: string;
-    resourceId: string;
-    organizationId: string;
-    type: PermissionResourceType;
-    accessRole?: UserPermissionAccessRole;
-    expiresAt?: number;
-    hasAccess: boolean;
 }