@veltdev/types 1.0.1

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

@@ -0,0 +1,118 @@
+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";
+export declare class CursorUser {
+    /**
+     * 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 email address.
+     */
+    email?: string;
+    /**
+    * Your user's display picture URL.
+    *
+    * Default: Random avatar image.
+    */
+    photoUrl?: string;
+    /**
+    * This field is used for the short comment that user can add to their live cursor.
+    *
+    */
+    comment?: string;
+    /**
+     * User’s live mouse position on the X axis.
+     *
+     * Auto generated.
+     */
+    positionX?: number;
+    /**
+     * User’s live mouse 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;
+    /**
+    * Auto updated when the user has their tab focused, inactive or closed.
+    * Values: active, inactive or offline.
+    *
+    * Auto generated.
+    */
+    onlineStatus: 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;
+    /**
+     * Server Timestamp.
+     *
+     */
+    timestamp: any;
+    /**
+    * User type.
+    *
+    */
+    type?: string;
+    selections?: any;
+    /**
+     * Unique document params id generated from prvoided 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?: object | null;
+    /**
+     * Unique location id generated from prvoided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    targetElement?: TargetElement | null;
+    position?: CursorPosition | null;
+    /**
+     * Readonly user
+     */
+    isReadOnly?: boolean;
+    /**
+     * Anonymous user can only view the comments
+     */
+    isAnonymous?: boolean;
+    pageInfo: PageInfo;
+}

package/app/models/data/custom-filter.data.model.d.ts

@@ -0,0 +1,26 @@
+export declare type StatusType = 'default' | 'ongoing' | 'terminal';
+export interface CustomFilter {
+    id: string;
+    color: string;
+    name: string;
+}
+export interface CustomPriority extends CustomFilter {
+    lightColor?: string;
+}
+export interface CustomStatus extends CustomFilter {
+    type: StatusType;
+    lightColor?: string;
+    svg?: string;
+    iconUrl?: string;
+}
+export interface CustomCategory extends CustomFilter {
+}
+export interface CustomCategoryMap {
+    [key: string]: CustomCategory;
+}
+export interface CustomStatusMap {
+    [key: string]: CustomStatus;
+}
+export interface CustomPriorityMap {
+    [key: string]: CustomPriority;
+}

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

@@ -0,0 +1,75 @@
+export interface IDeviceInfo {
+    userAgent?: string;
+    browserName?: string;
+    browserVersion?: string;
+    deviceType?: string;
+    osName?: string;
+    osVersion?: string;
+    screenWidth?: number;
+    screenHeight?: number;
+}
+export declare class DeviceInfo {
+    /**
+     * User’s user agent string.
+     */
+    userAgent?: string;
+    /**
+     * User’s browser name.
+     */
+    browserName?: string;
+    /**
+     * User’s browser version.
+     */
+    browserVersion?: string;
+    /**
+     * User’s device type.
+     */
+    deviceType?: string;
+    /**
+     * User’s device orientation.
+     */
+    orientation?: string;
+    /**
+     * User’s operating system name.
+     */
+    osName?: string;
+    /**
+     * User’s operating system version.
+     */
+    osVersion?: string;
+    /**
+     * User’s screen width.
+     */
+    screenWidth?: number;
+    /**
+     * User’s screen height.
+     */
+    screenHeight?: number;
+    /**
+     * Breakpoints stored with key as breakpoint media query and value as boolean.
+     */
+    static Breakpoints: {
+        [key: string]: boolean;
+    };
+    /**
+     * Orientations stored with key as orientation media query and value as boolean.
+     */
+    static Orientations: {
+        [key: string]: boolean;
+    };
+    constructor();
+    getBrowserName(): string;
+    getDeviceType(): string;
+    getOrientation(): string;
+    getOSName(): string;
+    getOSVersion(): string;
+    getBrowserVersion(): string;
+    getOperaVersion(): string;
+    getChromeVersion(): string;
+    getSafariVersion(): string;
+    getFirefoxVersion(): string;
+    getIEVersion(): string;
+    getScreenWidth(): number;
+    getScreenHeight(): number;
+    getDeviceInfo(): IDeviceInfo;
+}

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

@@ -0,0 +1,14 @@
+import { DocumentAccessType } from "../../utils/enums";
+import { UserIAM } from "./user-iam.data.model";
+export declare class DocumentIAM {
+    /**
+     * The document access type
+     */
+    documentAccessType: DocumentAccessType;
+    /**
+     * Users with access to the document
+     */
+    users: {
+        [userId: string]: UserIAM;
+    };
+}

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

@@ -0,0 +1,22 @@
+import { LocationMetadata } from "./location-metadata.model";
+import { PageInfo } from "./page-info.model";
+export declare class DocumentMetadata {
+    /**
+     * Unique document id generated from client document id
+     */
+    documentId?: string;
+    /**
+     * Document id provided by client
+     */
+    clientDocumentId?: string | number;
+    /**
+     * Page metadata
+     */
+    pageInfo?: PageInfo;
+    /**
+     *
+     */
+    locations?: {
+        [locationId: number]: LocationMetadata;
+    };
+}

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

@@ -0,0 +1,94 @@
+export declare class DocumentPaths {
+    /**
+     * The document's unique identifier.
+     */
+    documentId?: string;
+    /**
+     * Presence path.
+     */
+    presence?: string;
+    /**
+     * Cursor path.
+     */
+    cursor?: string;
+    /**
+     * Area path.
+     */
+    area?: string;
+    /**
+     * Arrow path.
+     */
+    arrow?: string;
+    /**
+     * Comment path.
+     */
+    comment?: string;
+    /**
+     * Huddle path.
+     */
+    audioHuddle?: string;
+    /**
+     * Document Id provided by the user.
+     */
+    clientDocumentId?: string;
+    /**
+     * Group contacts path.
+     */
+    groupContacts?: string;
+    /**
+     * Global contacts path.
+     */
+    globalContacts?: string;
+    /**
+     * User login path.
+     */
+    logins?: string;
+    /**
+     * Selection path.
+     */
+    selection?: string;
+    /**
+     * Tag path.
+     */
+    tag?: string;
+    /**
+     * Huddle path.
+     */
+    huddle?: string;
+    /**
+     * Document metadata path.
+     */
+    metadata?: string;
+    /**
+     * Recorder path.
+     */
+    recorder?: string;
+    /**
+     * IAM (Identity and Access Management) path.
+     */
+    iam?: string;
+    /**
+     * Document IAM (Identity and Access Management) path.
+     */
+    documentIam?: string;
+    /**
+     * Document users path.
+     */
+    users?: string;
+    /**
+     * User feedback path.
+     */
+    userFeedback?: string;
+    /**
+     * User report bugs path.
+     */
+    userReportBugs?: string;
+    /**
+     * User contact us path.
+     */
+    userContactUs?: string;
+    /**
+     * User follow along path.
+     */
+    flock?: string;
+}

package/app/models/data/document-user.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 DocumentUser {
+    /**
+     * 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/flock-options.model.d.ts

@@ -0,0 +1,7 @@
+import { PageInfo } from './page-info.model';
+export declare class FlockOptions {
+    useHistoryAPI: boolean;
+    onNavigate?: (url: PageInfo) => void;
+    disableDefaultNavigation: boolean;
+    darkMode: boolean;
+}

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

@@ -0,0 +1,17 @@
+import { User } from "./user.data.model";
+export declare class Attendee extends User {
+    state?: {
+        audioState: boolean;
+        videoState: boolean;
+        screenSharingState: boolean;
+    };
+    timestamp?: number;
+    initialHuddleMode?: {
+        audioState?: boolean;
+        videoState?: boolean;
+        screenSharing?: boolean;
+    };
+    streamMetadata?: any;
+    initialHuddleType?: 'audio' | 'video' | 'presentation';
+    huddleOnCursorMode?: boolean;
+}

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

@@ -0,0 +1,7 @@
+import { LiveStateData } from "./live-state-data.data.model";
+export declare class LiveStateDataMap {
+    /**
+     * Map of all unique LiveStateData set by you on the given document.
+     */
+    [liveStateDataId: string]: LiveStateData;
+}

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

@@ -0,0 +1,11 @@
+export declare class LiveStateData {
+    /**
+     * Unique identifier to identify the state data you are syncing.
+     */
+    liveStateDataId: string;
+    /**
+     * The data that you want to be synced across clients on the given document.
+     *
+     */
+    data: string | number | boolean | JSON;
+}

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

@@ -0,0 +1,4 @@
+import { User } from "./user.data.model";
+export declare class LocalStorageData {
+    snippylyAvatar?: User;
+}

package/app/models/data/location-metadata.model.d.ts

@@ -0,0 +1,16 @@
+import { Location } from "./location.model";
+import { PageInfo } from "./page-info.model";
+export declare class LocationMetadata {
+    /**
+     * Unique location id generated from client location information
+     */
+    locationId?: number;
+    /**
+     * Location object provided by a client
+     */
+    location?: Location | null;
+    /**
+     * Page metadata
+     */
+    pageInfo?: PageInfo;
+}

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

@@ -0,0 +1,15 @@
+export declare class Location {
+    /**
+     * Name of the location.
+     */
+    locationName?: string;
+    /**
+     * Version provided by the user.
+     */
+    version?: string;
+    /**
+     * View mode, possible values are 'internal', 'external' and 'all'.
+     */
+    view?: string;
+    [key: string]: any;
+}

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

@@ -0,0 +1,14 @@
+export declare class MediaPreviewConfig {
+    audio?: {
+        enabled?: boolean;
+        deviceId?: string;
+    };
+    video?: {
+        enabled?: boolean;
+        deviceId?: string;
+    };
+    screen?: {
+        enabled?: boolean;
+        stream?: MediaStream;
+    };
+}

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

@@ -0,0 +1,41 @@
+import { AreaStatus, ArrowStatus, CommentStatus, TagStatus } from "../../utils/enums";
+import { DocumentMetadata } from "./document-metadata.model";
+import { DocumentUser } from "./document-user.data.model";
+import { UserContactUs } from "./user-contact-us.data.model";
+import { UserContact } from "./user-contact.data.model";
+import { UserFeedback } from "./user-feedback.data.model";
+import { UserReportBug } from "./user-report-bug.data.model";
+import { User } from "./user.data.model";
+export declare class Notification {
+    actionUser?: User;
+    /**
+     * Source of a notification
+     */
+    notificationSource?: 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug';
+    /**
+     * Type of notification like 'Added', 'Updated' etc.
+     */
+    actionType?: AreaStatus | ArrowStatus | CommentStatus | TagStatus;
+    /**
+     * Annotation object
+     */
+    annotationData?: any;
+    /**
+     * Comment object for comment annotation
+     */
+    targetAnnotationData?: any;
+    recordingType?: string;
+    huddleType?: string;
+    huddleInvitees?: UserContact[];
+    oldStatus?: string;
+    newStatus?: string;
+    metadata?: DocumentMetadata & {
+        apiKey?: string;
+    } | null;
+    documentUser?: DocumentUser;
+    oldAccess?: string;
+    newAccess?: string;
+    userFeedback?: UserFeedback;
+    userReportBug?: UserReportBug;
+    userContactUs?: UserContactUs;
+}

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

@@ -0,0 +1,46 @@
+import { IDeviceInfo } from "./device-info.model";
+export declare class PageInfo {
+    /**
+     * URL of the webpage
+     */
+    url?: string;
+    /**
+     * Path of the webpage excluding base url
+     */
+    path?: string;
+    /**
+     * Base URL (domain) of a webpage
+     */
+    baseUrl?: string;
+    /**
+     * Title of the webpage
+     */
+    title?: string;
+    /**
+     * Reference url of a arrow annotation
+     */
+    arrowUrl?: string;
+    /**
+     * Reference url of a area annotation
+     */
+    areaUrl?: string;
+    /**
+     * Reference url of a comment annotation
+     */
+    commentUrl?: string;
+    /**
+     * Reference url of a tag annotation
+     */
+    tagUrl?: string;
+    /**
+     * Reference url of a recorder annotation
+     */
+    recorderUrl?: string;
+    /**
+     * User’s screen width.
+     *
+     * Auto generated.
+     */
+    screenWidth?: number;
+    deviceInfo?: IDeviceInfo;
+}

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

@@ -0,0 +1,14 @@
+export declare class Permission {
+    /**
+     * Unique id of the permission
+     */
+    id: string;
+    /**
+     * Name of the permission
+     */
+    name: string;
+    /**
+     * Description of the permission
+     */
+    description: string;
+}

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

@@ -0,0 +1,79 @@
+import { Location } from "./location.model";
+import { PageInfo } from "./page-info.model";
+export declare class PresenceUser {
+    /**
+     * 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 email address.
+     */
+    email?: string;
+    /**
+    * Your user's display picture URL.
+    *
+    * Default: Random avatar image.
+    */
+    photoUrl?: string;
+    /**
+    * Auto updated when the user has their tab focused, inactive or closed.
+    * Values: active, inactive or offline.
+    *
+    * Auto generated.
+    */
+    onlineStatus: 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;
+    /**
+     * Server Timestamp.
+     *
+     */
+    timestamp: any;
+    /**
+    * User type.
+    *
+    */
+    type?: string;
+    selections?: any;
+    /**
+     * Unique document params id generated from prvoided 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?: object | null;
+    /**
+     * Unique location id generated from prvoided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    /**
+     * Readonly user
+     */
+    isReadOnly?: boolean;
+    /**
+     * Anonymous user can only view the comments
+     */
+    isAnonymous?: boolean;
+    pageInfo: PageInfo;
+}