@veltdev/types 1.0.1

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

@@ -0,0 +1,120 @@
+import { Attachment } from "./attachment.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 { User } from "./user.data.model";
+export declare class RecorderAnnotation {
+    /**
+     * Unique identifier for the recorder pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * The user who created this recorder pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * Color used for the recorder pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * Timestamp when the recorder annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Recorder annotation's position on the X axis.
+     *
+     * Auto generated.
+     */
+    positionX?: number;
+    /**
+     * Recorder annotation's position on the Y axis.
+     *
+     * Auto generated.
+     */
+    positionY?: number;
+    /**
+     * User’s screen width.
+     *
+     * Auto generated.
+     */
+    screenWidth?: number;
+    /**
+     * User’s screen height.
+     *
+     * Auto generated.
+     */
+    screenHeight?: number;
+    /**
+     * User’s screen scroll height.
+     *
+     * Auto generated.
+     */
+    screenScrollHeight?: number;
+    /**
+    * User’s screen scroll height.
+    *
+    * Auto generated.
+    */
+    screenScrollTop?: number;
+    /**
+     * Xpath of the element that was clicked.
+     *
+     * Auto generated.
+     */
+    recorderedElementPath?: string;
+    /**
+     * Xpath of the element that was clicked.
+     *
+     * Auto generated.
+     */
+    recorderedElementRect?: any;
+    targetElement?: TargetElement | null;
+    position?: CursorPosition | null;
+    /**
+     * Unique location id generated from prvoided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    type?: string;
+    recordingType: string;
+    mode: 'floating' | 'thread';
+    approved?: boolean;
+    /**
+     * Attachment object of recorded media
+     * @deprecated Set attachment in attachments array
+     */
+    attachment: Attachment | null;
+    /**
+     * List of attachments for the annotation.
+     * It will be added when recording is converted to other formats.
+     */
+    attachments: Attachment[];
+    /**
+     * 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;
+    /**
+     * Recorded time in milliseconds and default (hh:mm:ss) display format
+     */
+    recordedTime?: {
+        duration?: number;
+        display?: string;
+    } | null;
+    /**
+     * Transcription of the recorded media
+     */
+    transcription?: Transcription;
+}

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

@@ -0,0 +1,74 @@
+/// <reference types="dom-mediacapture-record" />
+import { Observable } from "rxjs";
+export declare class RecorderConfig {
+    type: {
+        audio?: boolean;
+        video?: boolean;
+        screen?: boolean;
+    };
+    recorderOptions?: MediaRecorderOptions;
+}
+export declare class RecorderInitData {
+    /**
+     * Media Recorder status
+     */
+    status: Observable<string | null>;
+    /**
+     * Media Recorder stream
+     */
+    stream?: MediaStream;
+    /**
+     * Media Recorder recorded time
+     */
+    recordedTime: Observable<{
+        duration?: number;
+        display?: string;
+    } | null>;
+    /**
+     * Type of media recorder, possible values are 'audio', 'video' and 'screen'
+     */
+    type: 'audio' | 'video' | 'screen';
+    /**
+     * Observable of recorded raw data.
+     */
+    recordedRawData$: Observable<RecordedRawData | null>;
+}
+export declare class RecordedRawData {
+    /**
+     * Blob object of recorded data
+     */
+    blob: Blob;
+    /**
+     * Base64 URL of recorded data
+     */
+    url: string;
+    /**
+     * Type of recorded data, possible values are 'audio' and 'video'
+     */
+    type: 'audio' | 'video' | 'screen';
+    /**
+     * Base64 encoded string of thumbnail image of one frame of recorded video
+     */
+    thumbnail?: string;
+    /**
+     * Recorded time
+     */
+    recordedTime?: {
+        duration?: number;
+        display?: string;
+    } | null;
+}
+export declare class RecordedData {
+    /**
+     * Annotation ID of recorder annotation
+     */
+    id: string;
+    /**
+     * Recorder player tag containing recorder annotation id which can be added anywhere on the DOM
+     */
+    tag: string;
+    /**
+     * Type of recorded data, possible values are 'audio', 'video' and 'screen'
+     */
+    type: string;
+}

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

@@ -0,0 +1,62 @@
+import { Location } from "./location.model";
+import { PageInfo } from "./page-info.model";
+import { TargetTextRange } from "./target-text-range.data.model";
+import { User } from "./user.data.model";
+export declare class RewriterAnnotation {
+    /**
+     * Unique identifier for the rewriter pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * The user who created this rewriter pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * Color used for the rewriter pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * Timestamp when the rewriter annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Unique document params id generated from provided document params
+     * @deprecated `documentParamsId` is deprecated and will be removed in next release, use `locationId` instead.
+     */
+    documentParamsId?: number | null;
+    /**
+     * Set document params to identify user on sub document
+     * @deprecated `documentParams` is deprecated and will be removed in next release, use `location` instead.
+     */
+    documentParams?: Location | null;
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    type?: string;
+    rewriterType: 'generic' | 'copywriter';
+    /**
+     * Selected text range of rewriter annotation
+     */
+    targetTextRange?: TargetTextRange | null;
+    /**
+     * 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;
+    /**
+     * Selected rewriter option
+     */
+    selectedRewriterOption?: string;
+}

package/app/models/data/screen-size.data.model.d.ts

@@ -0,0 +1,14 @@
+export declare class ScreenSize {
+    /**
+     * User's current screen width.
+     */
+    screenWidth: number;
+    /**
+     * User's current screen height.
+     */
+    screenHeight: number;
+    /**
+    * User's current screen height.
+    */
+    screenScrollHeight: number;
+}

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

@@ -0,0 +1,22 @@
+import { PageInfo } from "./page-info.model";
+import { TargetTextRange } from "./target-text-range.data.model";
+import { User } from "./user.data.model";
+export declare class Selection {
+    /**
+     * User focused on specific element or text
+     */
+    user?: User;
+    /**
+     * Type of event through highlight event is fired
+     */
+    type?: 'focus' | 'click' | 'selection';
+    /**
+     * XPath of highlighted element
+     */
+    targetElement?: string | null;
+    /**
+     * Selected text to highlight
+     */
+    targetTextRange?: TargetTextRange | null;
+    pageInfo: PageInfo;
+}

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

@@ -0,0 +1,113 @@
+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 { TargetTextRange } from "./target-text-range.data.model";
+import { User } from "./user.data.model";
+export declare class TagAnnotation {
+    /**
+     * Unique identifier for the tag pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * The user who created this tag pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * List of users that were tagged.
+     *
+     */
+    to: User[];
+    /**
+     * Color used for the tag pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * Whether the tag annotation is marked resolved.
+     *
+     */
+    resolved?: boolean;
+    /**
+     * Timestamp when the tag annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Tag annotation's position on the X axis.
+     *
+     * Auto generated.
+     */
+    positionX?: number;
+    /**
+     * Tag annotation's position on the Y axis.
+     *
+     * Auto generated.
+     */
+    positionY?: number;
+    /**
+     * User’s screen width.
+     *
+     * Auto generated.
+     */
+    screenWidth?: number;
+    /**
+     * User’s screen height.
+     *
+     * Auto generated.
+     */
+    screenHeight?: number;
+    /**
+     * User’s screen scroll height.
+     *
+     * Auto generated.
+     */
+    screenScrollHeight?: number;
+    /**
+    * User’s screen scroll height.
+    *
+    * Auto generated.
+    */
+    screenScrollTop?: number;
+    /**
+     * Xpath of the element that was clicked.
+     *
+     * Auto generated.
+     */
+    taggedElementPath?: string;
+    /**
+     * Xpath of the element that was clicked.
+     *
+     * Auto generated.
+     */
+    taggedElementRect?: any;
+    /**
+     * Target element of attached annotation.
+     */
+    targetElement?: TargetElement | null;
+    position?: CursorPosition | null;
+    /**
+     * Unique location id generated from prvoided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    type?: string;
+    targetTextRange?: TargetTextRange | null;
+    /**
+     * Approved status of the annotation.
+     */
+    approved?: boolean;
+    /**
+     * 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/target-element.data.model.d.ts

@@ -0,0 +1,18 @@
+export declare class TargetElement {
+    /**
+     * Xpath of target element
+     */
+    xpath?: string;
+    /**
+     * Full xpath of target element
+     */
+    fXpath?: string;
+    /**
+     * Relative top position of cursor on target element
+     */
+    topPercentage: number;
+    /**
+     * Relative left position of cursor on target element
+     */
+    leftPercentage: number;
+}

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

@@ -0,0 +1,14 @@
+export declare class TargetTextRange {
+    /**
+     * Xpath of common Ancestor Container
+     */
+    commonAncestorContainer?: string;
+    /**
+     * Selected text
+     */
+    text?: string;
+    /**
+     * Occurrence of selected text
+     */
+    occurrence?: number;
+}

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

@@ -0,0 +1,19 @@
+export declare class Toast {
+    /**
+     * Unique id for toast notification
+     */
+    id?: number;
+    /**
+     * Message to show in toast notification
+     */
+    message: string;
+    /**
+     * Type of toast notification
+     */
+    type: 'success' | 'error';
+    /**
+     * Duration to show toast notification in milliseconds
+     * @default 3000 milliseconds (3 seconds)
+     */
+    duration?: number;
+}

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

@@ -0,0 +1,35 @@
+import { User } from "./user.data.model";
+export declare class Transcription {
+    /**
+     * User who created the transcription
+     */
+    from: User;
+    /**
+     * Timestamp of when the transcription was created
+     */
+    lastUpdated?: number;
+    /**
+     * Bucket path of the srt file
+     */
+    srtBucketPath?: string;
+    /**
+     * Srt file url
+     */
+    srtUrl?: string;
+    /**
+     * Transcripted text
+     */
+    transcriptedText?: string;
+    /**
+     * Time taken in ms to transcribe the recording
+     */
+    transcriptionLatency?: number;
+    /**
+     * Bucket path of the vtt file
+     */
+    vttBucketPath?: string;
+    /**
+     * Vtt file url
+     */
+    vttUrl?: string;
+}

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

@@ -0,0 +1,3 @@
+import { UserRequest } from "./user-request.data.model";
+export declare class UserContactUs extends UserRequest {
+}

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

@@ -0,0 +1,29 @@
+export declare class UserContact {
+    /**
+     * Unique user identifier that you use to identify your user.
+     */
+    userId: string;
+    /**
+     * Your user's full name.
+     *
+     * Default: Random avatar name.
+     */
+    name?: string;
+    /**
+     * Your user's display picture URL.
+     *
+     * Default: Random avatar image.
+     */
+    photoUrl?: string;
+    /**
+     * This is required if you want us to send email or slack notifications
+     * to users when they add comments and tag their co-workers.
+     */
+    email: string;
+    /**
+    * It could be a domain name or any identifier you use to cluster a group of users who work together.
+    */
+    groupId?: string;
+    source?: string;
+    visibility: 'group' | 'private';
+}

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

@@ -0,0 +1,3 @@
+import { UserRequest } from "./user-request.data.model";
+export declare class UserFeedback extends UserRequest {
+}

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

@@ -0,0 +1,33 @@
+import { UserContact } from "./user-contact.data.model";
+import { UserRole } from "./user-role.data.model";
+import { User } from "./user.data.model";
+export declare class UserIAM {
+    /**
+   * The user's id (Email id of the user)
+   */
+    id: string;
+    /**
+     * The user's contact details
+     */
+    user: UserContact;
+    /**
+     * The user's role in the document
+     */
+    role: UserRole;
+    /**
+     * User who invited this user
+     */
+    invitedBy?: User;
+    /**
+     * Date when this user was invited
+     */
+    invitedDate?: any;
+    /**
+     * User who updated this user
+     */
+    updatedBy?: User;
+    /**
+     * Date when this user was updated
+     */
+    updatedDate?: any;
+}

package/app/models/data/user-report-bug.data.model.d.ts

@@ -0,0 +1,3 @@
+import { UserRequest } from "./user-request.data.model";
+export declare class UserReportBug extends UserRequest {
+}

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

@@ -0,0 +1,37 @@
+import { DocumentMetadata } from "./document-metadata.model";
+import { PageInfo } from "./page-info.model";
+import { User } from "./user.data.model";
+export declare class UserRequest {
+    /**
+     * Unique id of the feedback
+     */
+    id?: string;
+    /**
+     * apiKey of the client
+     */
+    apiKey?: string | null;
+    /**
+     * Email id of the feedback giver
+     */
+    emailId?: string;
+    /**
+     * Message given by the user
+     */
+    message?: string;
+    /**
+     * User who added the feedback
+     */
+    from?: User | null;
+    /**
+     * Date when the feedback was added
+     */
+    lastUpdated?: any;
+    /**
+     * Document metadata
+     */
+    metadata?: DocumentMetadata | null;
+    /**
+     * User's page info
+     */
+    pageInfo?: PageInfo;
+}

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

@@ -0,0 +1,19 @@
+import { Permission } from "./permission.data.model";
+export declare class UserRole {
+    /**
+     * Unique id of the user role
+     */
+    id: string;
+    /**
+     * Name of the user role
+     */
+    name: string;
+    /**
+     * Description of the user role
+     */
+    description: string;
+    /**
+     * Permissions associated with the user role
+     */
+    permissions: Permission[];
+}

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

@@ -0,0 +1,60 @@
+import { UserContact } from "./user-contact.data.model";
+export declare class User {
+    /**
+     * Unique user identifier that you use to identify your user.
+     */
+    userId: string;
+    /**
+     * Your user's full name.
+     *
+     * Default: Random avatar name.
+     */
+    name?: string;
+    /**
+    * Your user's display picture URL.
+    *
+    * Default: Random avatar image.
+    */
+    photoUrl?: string;
+    /**
+     * This is required if you want us to send email or slack notifications
+     * to users when they add comments and tag their co-workers.
+     */
+    email?: string;
+    /**
+    * This will help us show a drop down when a user wants to tag their co-workers in a comment.
+    */
+    contacts?: UserContact[];
+    /**
+     * The product plan your user is on.
+     */
+    plan?: string;
+    /**
+    * It could be a domain name or any identifier you use to cluster a group of users who work together.
+    */
+    groupId?: string;
+    /**
+     * Auto generated unique user id that is linked with your app's user ID.
+     * This is needed by us for internal processing.
+     */
+    userSnippylyId?: string;
+    /**
+     * A random color is assigned to the user for the current session.
+     * This is the color on the avatar border and live cursor, if these features are enabled.
+     */
+    color?: string;
+    /**
+     * User type.
+     *
+     */
+    type?: string;
+    isAdmin?: boolean;
+    /**
+     * Readonly user
+     */
+    isReadOnly?: boolean;
+    /**
+     * Anonymous user can only view the comments
+     */
+    isAnonymous?: boolean;
+}