@veltdev/types 1.0.1

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

@@ -0,0 +1,141 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+import { Config } from "../models/data/config.data.model";
+import { DocumentUser } from "../models/data/document-user.data.model";
+import { Location } from "../models/data/location.model";
+import { User } from "../models/data/user.data.model";
+import { CommentElement } from "../models/element/comment-element.model";
+import { ContactElement } from "../models/element/contact-element.model";
+import { CursorElement } from "../models/element/cursor-element.model";
+import { PresenceElement } from "../models/element/presence-element.model";
+import { RecorderElement } from "../models/element/recorder-element.model";
+import { RewriterElement } from "../models/element/rewriter-element.model";
+import { SelectionElement } from "../models/element/selection-element.model";
+import { TagElement } from "../models/element/tag-element.model";
+import { FeatureType } from "../utils/enums";
+export declare class Snippyly {
+  constructor();
+  initConfig: (apiKey: string, config?: Config) => void;
+  identify: (user: User) => Promise<unknown>;
+  /**
+   * Tell us who the currently logged in user is.
+   *
+   * Call whenever the user is updated: signs in, signs out, signs up etc.
+   */
+  updateUser: (user: User) => void;
+  /**
+   * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
+   * @param id unique document ID
+   */
+  setDocumentId: (id: string) => void;
+  /**
+   * Tell us the custom params of the current document/resource to identify sub document inside a document.
+   * @param params Document Params
+   * @deprecated This method is depercated and will be removed in next release. Use `setLocation` method instead.
+   */
+  setDocumentParams: (params: Location) => void;
+  /**
+   * Tell us the custom params of the current document/resource to identify sub document inside a document.
+   * @param params Locaion
+   */
+  setLocation: (params: Location) => void;
+  /**
+   * To remove document params from a User
+   * @deprecated This method is depercated and will be removed in next release. Use `removeLocation` method instead.
+   */
+  removeDocumentParams: () => void;
+  /**
+     * To remove location from a User
+     */
+  removeLocation: () => void;
+  /**
+   * Tell us the about the scrollable document ids to keep track on its scroll changes
+   * @param ids scrollable elements ids
+   */
+  setScrollableElementsIds: (ids: string[]) => void;
+  /**
+   * To remove document params from a User
+   */
+  removeScrollableElementsIds: () => void;
+  /**
+   * Get the Presence Element Object to access the raw presence data.
+   *
+   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+   */
+  getPresenceElement: () => PresenceElement;
+  /**
+   * Get the Cursor Element Object to access the raw cursor data.
+   *
+   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+   */
+  getCursorElement: () => CursorElement;
+  /**
+   * Get the Comment Element Object to access the raw comment data.
+   *
+   * This is for Pros who don’t want to use Snippyly Comment web component and want to design their own UI.
+   */
+  getCommentElement: () => CommentElement;
+  /**
+   * Get the Tag Pin Annotation Object to access the raw tag data.
+   *
+   * This is for Pros who don’t want to use Snippyly Tag web component and want to design their own UI.
+   */
+  getTagElement: () => TagElement;
+  /**
+   * Get the Selection Object to enable/disable the feature.
+   */
+  getSelectionElement: () => SelectionElement;
+  /**
+   * Get the Recorder Object.
+   */
+  getRecorderElement: () => RecorderElement;
+  /**
+   * Get the Contact Object.
+   */
+  getContactElement: () => ContactElement;
+  /**
+   * Get the Rewriter Object.
+   */
+  getRewriterElement: () => RewriterElement;
+  /**
+   * To signout a user
+   */
+  signOutUser: () => any;
+  /**
+   * Provide a list of features to disable.
+   * Provide an empty array to enable all the features.
+   * @param features List of features
+   */
+  disableFeatures: (features: Array<FeatureType>) => void;
+  /**
+   * Add location to show comments, tags, recorders etc. for provided location also.
+   * @param location Location object
+   */
+  addLocation: (location: any) => any;
+
+  /**
+   * To check if user allowed in provided document or not.
+   */
+  isUserAllowed$: () => Observable<boolean>;
+
+  /**
+   * To get user role in provided document.
+   */
+  getUserRole$: () => Observable<string | null>;
+
+  /**
+   * To check if plan is expired or not.
+   */
+  isPlanExpired$: () => Observable<boolean>;
+
+  /**
+   * To invite list of users to the document.
+   * @param documentUsers List of document users
+   */
+  inviteUsers: (documentUsers: Array<DocumentUser>) => void;
+
+  /**
+   * To remove snippyly specific content from provided html content.
+   */
+  removeSnippylyContent: (htmlContent: string) => string;
+}

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

@@ -0,0 +1,5 @@
+import { Snippyly } from './snippyly.model';
+
+export declare class Velt extends Snippyly {
+
+}

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

@@ -0,0 +1,30 @@
+export declare class AnnotationProperty {
+    /**
+     * Viewport width.
+     */
+    viewportWidth?: number;
+    /**
+     * Viewport height.
+     */
+    viewportHeight?: number;
+    /**
+     * Screen width.
+     */
+    screenWidth?: number;
+    /**
+     * Screen height.
+     */
+    screenHeight?: number;
+    /**
+     * Screen scroll height.
+     */
+    screenScrollHeight?: number;
+    /**
+     * Length of the arrow.
+     */
+    arrowLength?: number;
+    /**
+     * Angle of the arrow.
+     */
+    arrowAngle?: number;
+}

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

@@ -0,0 +1,74 @@
+import { AnnotationProperty } from "./annotation-property.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 { User } from "./user.data.model";
+export declare class AreaAnnotation {
+    /**
+     * Unique identifier for the area pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * The user who created this area pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * Color used for the area pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * Timestamp when the area annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    targetElement?: TargetElement | null;
+    /**
+     * Target elements of attached annotation.
+     */
+    targetElements?: (TargetElement | null)[];
+    position?: CursorPosition | null;
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    type?: string;
+    props: AnnotationProperty;
+    /**
+     * 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;
+    areaProperties?: AreaProperty;
+    targetAnnotations: AreaTargetAnnotation[];
+}
+export declare class AreaTargetAnnotation {
+    /**
+     * Type of the annotation (ex. comment, tag etc.)
+     */
+    type?: string;
+    /**
+     * Unique identifier for the annotation.
+     */
+    annotationId?: string;
+    /**
+     * Position reference to show this annotation on area annotation.
+     */
+    position?: string;
+}
+export declare class AreaProperty {
+    targetElement?: string;
+    handle1?: any;
+    handle2?: any;
+    coordinates?: any;
+}

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

@@ -0,0 +1,40 @@
+export declare class Attachment {
+    /**
+     * Unique identifier for the comment pin annotation.
+     *
+     * Auto generated.
+     */
+    attachmentId: number;
+    /**
+     * File name
+     */
+    name?: string;
+    /**
+     * Unique path in storage
+     */
+    bucketPath?: string;
+    /**
+     * File size
+     */
+    size?: number;
+    /**
+     * File type
+     */
+    type?: string;
+    /**
+     * Download url of a file
+     */
+    url?: string;
+    /**
+     * Thumbnail img in base64 format
+     */
+    thumbnail?: string;
+    /**
+     * Metadata of an attachment
+     */
+    metadata?: any;
+    /**
+     * Mime type of an attachment
+     */
+    mimeType?: any;
+}

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

@@ -0,0 +1,10 @@
+export declare class ChatGPT {
+    /**
+     * Role of content (like: user, assistant, system etc.)
+     */
+    role?: 'user' | 'assistant' | 'system';
+    /**
+     * Content of the message
+     */
+    content?: string;
+}

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

@@ -0,0 +1,161 @@
+import { Comment } from "./comment.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { CustomCategory, CustomPriority, CustomStatus } from "./custom-filter.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 CommentAnnotation {
+    /**
+     * Unique identifier for the comment pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * This is the list of all comments part of this annotation.
+     *
+     */
+    comments: Comment[];
+    /**
+     * The list of categories that this comment pin annotation belongs to.
+     */
+    commentCategories: CustomCategory[];
+    /**
+     * The user who created this comment pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * Color used for the comment pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * @deprecated
+     * Whether the comment annotation is marked resolved.
+     *
+     */
+    resolved?: boolean;
+    /**
+     * @deprecated
+     * Whether the comment annotation is marked as in progress.
+     *
+     */
+    inProgress?: boolean;
+    /**
+     * Timestamp when the comment annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Comment annotation's position on the X axis.
+     *
+     * Auto generated.
+     */
+    positionX?: number;
+    /**
+     * Comment 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 comment annotation
+     */
+    targetElement?: TargetElement | null;
+    /**
+     * Target element id provided by user
+     */
+    targetElementId?: string | null;
+    position?: CursorPosition | null;
+    /**
+     * 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;
+    /**
+     * Selected text range of comment annotation
+     */
+    targetTextRange?: TargetTextRange | null;
+    approved?: boolean;
+    status: CustomStatus;
+    /**
+     * 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;
+    assignedTo?: User;
+    priority?: CustomPriority;
+    ghostComment?: GhostComment | null;
+    /**
+     * Connected area annotation id of comment annotation
+     */
+    areaAnnotationId?: string;
+    /**
+     * Custom context data provided by the user
+     */
+    context?: any;
+}
+export declare class GhostComment {
+    targetElement?: TargetElement | null;
+    message?: string;
+    type?: string;
+    /**
+     * To check if comment is from same device group or not, device groups are ['mobile', 'tablet'] and ['desktop', 'monitor']
+     */
+    isSameGroup?: boolean;
+}

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

@@ -0,0 +1,71 @@
+import { Attachment } from "./attachment.model";
+import { RecordedData } from "./recorder.model";
+import { User } from "./user.data.model";
+export declare class Comment {
+    /**
+     * Unique identifier for the comment pin annotation.
+     *
+     * Auto generated.
+     */
+    commentId: number;
+    /**
+     * This determines the comment content type.
+     *
+     * Default: 'text'.
+     */
+    type: 'text' | 'voice';
+    /**
+     * Comment Text.
+     *
+     */
+    commentText: string;
+    /**
+     * Same comment text in HTML.
+     *
+     */
+    commentHtml?: string;
+    /**
+     * Comment voice recording url.
+     *
+     */
+    commentVoiceUrl?: string;
+    /**
+     * The user who created this comment text.
+     *
+     */
+    from: User;
+    /**
+     * List of users that were tagged using @mentions to this comment.
+     *
+     */
+    to?: User[];
+    /**
+     * Timestamp when this comment content was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: Date;
+    status: 'added' | 'updated';
+    /**
+     * List of attachments.
+     */
+    attachments: Attachment[];
+    /**
+     * List of recorded data.
+     */
+    recorders: RecordedData[];
+    /**
+     * Map of user ID to another map of emoji to count.
+     */
+    reactions: {
+        [key: string]: {
+            [key: string]: number;
+        };
+    };
+    /**
+     * Map of emoji to count to display.
+     */
+    reactionCountMap: {
+        [key: string]: number;
+    };
+}

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

@@ -0,0 +1,45 @@
+import { FeatureType } from "../../utils/enums";
+export declare class Config {
+    /**
+     * Restrict Snippyly features to specific pages. You can specify partial URL strings.
+     *
+     * Default: All pages where snippyly script or snippyly web components are added.
+     */
+    urlAllowList?: string[];
+    /**
+     * Only allow the provided Snippyly features to run.
+     *
+     * Default: All features are enabled.
+     */
+    featureAllowList?: Array<FeatureType>;
+    /**
+     * Restrict Snippyly features to specific user plans.
+     *
+     * Default: All users.
+     */
+    userPlanAllowList?: string[];
+    /**
+     * Restrict Snippyly features to specific users.
+     *
+     * Default: All users.
+     */
+    userIdAllowList?: string[];
+    /**
+     * Restrict Snippyly features to specific groups/teams of users.
+     *
+     * Default: All groups/teams.
+     */
+    userGroupIdAllowList?: string[];
+    /**
+     * To enable/disable debug mode
+     *
+     * This change will be reflected after a page refresh
+     */
+    debugMode?: boolean;
+    /**
+     * To enable/disable prefers color scheme.
+     * If this is set to true, then we will listen to changes on the
+     * prefers-color-scheme media query to set the global theme of our components.
+     */
+    usePrefersColorScheme?: boolean;
+}

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

@@ -0,0 +1,10 @@
+export declare class CursorPosition {
+    /**
+     * Position top of cursor on viewer user's screen
+     */
+    top: number;
+    /**
+     * Position left of cursor on viewer user's screen
+     */
+    left: number;
+}