@veltdev/sdk-staging 1.0.1

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

@@ -0,0 +1,14 @@
+import { UserIAM } from "./user-iam.data.model";
+import { UserRole } from "./user-role.data.model";
+export declare class WorkspaceIAM {
+    /**
+     * List of roles
+     */
+    roles: UserRole[];
+    /**
+     * Users with access to the workspace
+     */
+    users: {
+        [userId: string]: UserIAM;
+    };
+}

package/app/models/element/area-element.model.d.ts

@@ -0,0 +1,23 @@
+// @ts-nocheck
+export declare class AreaElement {
+    /**
+     * To enable area feature
+     */
+    enableArea: () => void;
+
+    /**
+     * To disable area feature
+     */
+    disableArea: () => void;
+    constructor();
+
+    /**
+     * To enable area feature
+     */
+    private _enableArea;
+
+    /**
+     * To disable area feature
+     */
+    private _disableArea;
+}

package/app/models/element/comment-element.model.d.ts

@@ -0,0 +1,466 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+import { CommentPinAnnotation } from "../data/comment-pin-annotation.data.model";
+export declare class CommentElement {
+  /**
+   * Subscribe to comments on the current document.
+   *
+   * Returns Observable<CommentPinAnnotation[] | null>.
+   */
+  getAllCommentAnnotations: (documentId?: string, documentParams?: object) => Observable<CommentPinAnnotation[] | null>;
+
+  /**
+   * To delete selected comments
+   */
+  deleteComment: () => any;
+
+  /**
+   * To enable text comment selection
+   */
+  enableTextComments: () => any;
+
+  /**
+   * To disable text comment selection
+   */
+  disableTextComments: () => any;
+
+  /**
+   * To allow text selection in specific elements only
+   * @param elementIds Element ids to be allowed for text selection
+   */
+  allowedElementIds: (elementIds: string[]) => any;
+
+  /**
+   * To enable/disable floating comments
+   *
+   * By default floating comments will be enabled
+   *
+   * Pass `true` to disable floating comments
+   *
+   * Pass `false` to enable floating comments
+   *
+   * @param disable Enble/Disable floating comments
+   */
+  disableFloatingComments: (disable: boolean) => any;
+
+  /**
+   * To add comments on specific elements
+   *
+   * @param elementId ID of html element
+   */
+  attachComment: (elementId: string) => any;
+
+  /**
+   * To open comment sidebar
+   */
+  openCommentSidebar: () => any;
+
+  /**
+  * To close comment sidebar
+  */
+  closeCommentSidebar: () => any;
+
+  /**
+   * To toggle comment sidebar
+   */
+  toggleCommentSidebar: () => any;
+
+  /**
+  * To enable/disable moderator mode
+  *
+  * @param moderatorMode pass `true` to enable it, `false` to disable it.
+  */
+  enableModeratorMode: (moderatorMode: boolean) => any;
+
+  /**
+   * To enable/disable stream mode
+   *
+   * @param enable pass `true` to enable it, `false` to disable it.
+   */
+  enableStreamMode: (enable: boolean) => any;
+
+  /**
+   * To show sign in button in comments if user is signed out
+   *
+   * @param enable pass `true` to enable it, `false` to disable it.
+   */
+  enableSignInButton: (enable: boolean) => any;
+
+  /**
+   * Subscribe to add comment mode change.
+   *
+   * Returns Observable<boolean>.
+   */
+  addCommentModeChange: () => Observable<boolean>;
+
+  /**
+   * Enable this feature to add attachments in comments
+   *
+   * @param enable pass `true` to enable it, `false` to disable it.
+   */
+  enableAttachment: (enable: boolean) => any;
+
+  /**
+   * Enable this feature to show device info in comments
+   *
+   * @param showInfo pass `true` to show info, `false` to hide it.
+   */
+  showDeviceInfo: (showInfo: boolean) => any;
+
+  /**
+   * Enable comment mode to add comments.
+   */
+  public enableCommentMode: () => any;
+
+  /**
+   * Disable comment mode.
+   */
+  public disableCommentMode: () => any;
+
+  /**
+   * To show/hide comment number
+   * @param show pass `true` to show it, `false` to hide it.
+   */
+  public showCommentIndex: (show: boolean) => any;
+
+  /**
+   * To enable popover mode
+   */
+  public enablePopoverMode: () => any;
+
+  /**
+   * To disable popover mode
+   */
+  public disablePopoverMode: () => any;
+
+  /**
+   * To enable dialog on hover
+   */
+  public enableDialogOnHover: () => any;
+
+  /**
+   * To disable dialog on hover
+   */
+  public disableDialogOnHover: () => any;
+
+  /**
+   * To enable feature to show dialog on target element click
+   */
+  public enableDialogOnTargetElementClick: () => any;
+
+  /**
+   * To disable feature to show dialog on target element click
+   */
+  public disableDialogOnTargetElementClick: () => any;
+
+  /**
+   * To enable feature to set priority on comments
+   */
+  public enablePriority: () => any;
+
+  /**
+   * To disable feature to set priority on comments
+   */
+  public disablePriority: () => any;
+
+  /**
+   * To enable feature to set status on comments
+   */
+  public enableStatus: () => any;
+
+  /**
+   * To disable feature to set status on comments
+   */
+  public disableStatus: () => any;
+
+  /**
+   * To enable feature to resolve comments
+   */
+  public enableResolve: () => any;
+
+  /**
+   * To disable feature to resolve comments
+   */
+  public disableResolve: () => any;
+
+  /**
+   * To enable feature to show ghost comments
+   */
+  public enableGhostCommentsInDOM: () => any;
+
+  /**
+   * To disable feature to show ghost comments
+   */
+  public disableGhostCommentsInDOM: () => any;
+
+  /**
+   * To enable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  public enableGhostCommentsMessage: () => any;
+
+  /**
+   * To disable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  public disableGhostCommentsMessage: () => any;
+
+  /**
+   * To enable inbox mode
+   */
+  public enableInboxMode: () => any;
+
+  /**
+   * To disable inbox mode
+   */
+  public disableInboxMode: () => any;
+
+  /**
+   * To enable auto categorize feature
+   */
+  public enableAutoCategorize: () => any;
+
+  /**
+   * To disable auto categorize feature
+   */
+  public disableAutoCategorize: () => any;
+
+  /**
+   * To enable suggestion mode
+   */
+  public enableSuggestionMode: () => any;
+
+  /**
+   * To disable suggestion mode
+   */
+  public disableSuggestionMode: () => any;
+  constructor();
+  /**
+   * Subscribe to comments on the current document.
+   *
+   * Returns Observable<CommentPinAnnotation[] | null>.
+   */
+  private _getAllCommentAnnotations;
+
+  /**
+   * To delete selected comments
+   */
+  private _deleteComment;
+
+  /**
+  * To enable text comment selection
+  */
+  private _enableTextComments;
+
+  /**
+   * To disable text comment selection
+   */
+  private _disableTextComments;
+
+  /**
+   * To allow text selection in specific elements only
+   * @param elementIds Element ids to be allowed for text selection
+   */
+  private _allowedElementIds;
+
+  /**
+   * To enable/disable floating comments
+   *
+   * By default floating comments will be enabled
+   *
+   * Pass `true` to disable floating comments
+   *
+   * Pass `false` to enable floating comments
+   *
+   * @param disable Enble/Disable floating comments
+   */
+  private _disableFloatingComments;
+
+  /**
+   * To add comments on specific elements
+   *
+   * @param elementId ID of html element
+   */
+  private _attachComment;
+
+  /**
+   * To open comment sidebar
+   */
+  private _openCommentSidebar;
+
+  /**
+  * To close comment sidebar
+  */
+  private _closeCommentSidebar;
+
+  /**
+   * To toggle comment sidebar
+   */
+  private _toggleCommentSidebar;
+
+  /**
+  * To enable/disable moderator mode
+  *
+  * @param moderatorMode pass `true` to enable it, `false` to disable it.
+  */
+  private _enableModeratorMode;
+
+  /**
+   * To enable/disable stream mode
+   *
+   * @param enable pass `true` to enable it, `false` to disable it.
+   */
+  private _enableStreamMode;
+
+  /**
+   * To show sign in button in comments if user is signed out
+   *
+   * @param enable pass `true` to enable it, `false` to disable it.
+   */
+  private _enableSignInButton;
+
+  /**
+   * Subscribe to add comment mode change.
+   *
+   * Returns Observable<boolean>.
+   */
+  private _addCommentModeChange;
+
+  /**
+   * Enable this feature to add attachments in comments
+   *
+   * @param enable pass `true` to enable it, `false` to disable it.
+   */
+  private _enableAttachment;
+
+  /**
+   * Enable this feature to show device info in comments
+   *
+   * @param showInfo pass `true` to show info, `false` to hide it.
+   */
+  private _showDeviceInfo;
+
+  /**
+   * Enable comment mode to add comments.
+   */
+  private _enableCommentMode;
+
+  /**
+   * Disable comment mode.
+   */
+  private _disableCommentMode;
+
+  /**
+   * To show/hide comment number
+   * @param show pass `true` to show it, `false` to hide it.
+   */
+  private _showCommentIndex;
+
+  /**
+   * To enable popover mode
+   */
+  private _enablePopoverMode;
+
+  /**
+   * To disable popover mode
+   */
+  private _disablePopoverMode;
+
+  /**
+   * To enable dialog on hover
+   */
+  private _enableDialogOnHover;
+
+  /**
+   * To disable dialog on hover
+   */
+  private _disableDialogOnHover;
+
+  /**
+   * To enable feature to show dialog on target element click
+   */
+  private _enableDialogOnTargetElementClick;
+
+  /**
+   * To disable feature to show dialog on target element click
+   */
+  private _disableDialogOnTargetElementClick;
+
+  /**
+   * To enable feature to set priority on comments
+   */
+  private _enablePriority;
+
+  /**
+   * To disable feature to set priority on comments
+   */
+  private _disablePriority;
+
+  /**
+   * To enable feature to set status on comments
+   */
+  private _enableStatus;
+
+  /**
+   * To disable feature to set status on comments
+   */
+  private _disableStatus;
+
+  /**
+   * To enable feature to resolve comments
+   */
+  private _enableResolve;
+
+  /**
+   * To disable feature to resolve comments
+   */
+  private _disableResolve;
+
+  /**
+   * To enable feature to show ghost comments
+   */
+  private _enableGhostCommentsInDOM;
+
+  /**
+   * To disable feature to show ghost comments
+   */
+  private _disableGhostCommentsInDOM;
+
+  /**
+   * To enable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  private _enableGhostCommentsMessage;
+
+  /**
+   * To disable feature to show ghost comments message in comment dialog and comment sidebar
+   */
+  private _disableGhostCommentsMessage;
+
+  /**
+   * To enable inbox mode
+   */
+  private _enableInboxMode;
+
+  /**
+   * To disable inbox mode
+   */
+  private _disableInboxMode;
+
+  /**
+   * To enable auto categorize feature
+   */
+  private _enableAutoCategorize;
+
+  /**
+   * To disable auto categorize feature
+   */
+  private _disableAutoCategorize;
+
+  /**
+   * To enable suggestion mode
+   */
+  private _enableSuggestionMode;
+
+  /**
+   * To disable suggestion mode
+   */
+  private _disableSuggestionMode;
+}

package/app/models/element/contact-element.model.d.ts

@@ -0,0 +1,13 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+export declare class ContactElement {
+  /**
+   * Get if user is part of global contact or not.
+   */
+  public isUserGlobalContact: () => Observable<boolean>;
+  constructor();
+  /**
+   * Get if user is part of global contact or not.
+   */
+  private _isUserGlobalContact;
+}

package/app/models/element/cursor-element.model.d.ts

@@ -0,0 +1,42 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+import { CursorUser } from "../data/cursor-user.data.model";
+export declare class CursorElement {
+    /**
+     * Subscribe to cursors of all online users who are either active or inactive on the current document.
+     *
+     * Returns Observable<CursorUser[] | null>.
+     */
+    getLiveCursorsOnCurrentDocument: () => Observable<CursorUser[] | null>;
+
+    /**
+     * To set inactivity time (Default value is 2 minutes)
+     * @param time inactivity time in milliseconds
+     */
+    setInactivityTime: (time: number) => void;
+
+    /**
+     * To allow cursors in specific elements only
+     * @param elementIds Element ids to be allowed to show cursor on it
+     */
+    allowedElementIds: (elementIds: string[]) => any;
+    constructor();
+    /**
+     * Subscribe to cursors of all online users who are either active or inactive on the current document.
+     *
+     * Returns Observable<CursorUser[] | null>.
+     */
+    private _getLiveCursorsOnCurrentDocument;
+
+    /**
+     * To set inactivity time (Default value is 2 minutes)
+     * @param time inactivity time in milliseconds
+     */
+    private _setInactivityTime;
+
+    /**
+     * To allow cursors in specific elements only
+     * @param elementIds Element ids to be allowed to show cursor on it
+     */
+    private _allowedElementIds;
+}

package/app/models/element/presence-element.model.d.ts

@@ -0,0 +1,53 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+import { PresenceUser } from "../data/presence-user.data.model";
+export declare class PresenceElement {
+
+    /**
+     * Subscribe to a list of all online users who are either active or inactive on the current document.
+     *
+     * Returns Observable<PresenceUser[] | null>.
+     */
+    getOnlineUsersOnCurrentDocument: () => Observable<PresenceUser[] | null>;
+
+    /**
+     * To set inactivity time (Default value is 5 minutes)
+     * @param time inactivity time in milliseconds
+     */
+    setInactivityTime: (time: number) => void;
+
+    /**
+     * Enables follow along mode globally
+     * @param options {FollowOptions: {useHistoryAPI: boolean, onNavigate: (url: PageInfo) => void}}}
+     */
+    enableFollowAlongMode: (useHistoryAPI: boolean) => any;
+
+    /**
+     * To disable follow along mode
+     */
+    disableFollowAlongMode: () => any;
+    constructor();
+    /**
+     * Subscribe to a list of all online users who are either active or inactive on the current document.
+     *
+     * Returns Observable<PresenceUser[] | null>.
+     */
+    private _getOnlineUsersOnCurrentDocument;
+
+    /**
+     * To set inactivity time (Default value is 5 minutes)
+     * @param time inactivity time in milliseconds
+     */
+    private _setInactivityTime;
+
+    /**
+     * Enables follow along mode globally
+     * @param options {FollowOptions: {useHistoryAPI: boolean, onNavigate: (url: PageInfo) => void}}}
+     */
+    private _enableFollowAlongMode;
+
+    /**
+     * To disable follow along mode
+     */
+    private _disableFollowAlongMode;
+}

package/app/models/element/recorder-element.model.d.ts

@@ -0,0 +1,15 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+
+export declare class RecorderElement {
+
+    initRecording: (type: string, panelId?: string) => any;
+
+    onRecordedData: () => Observable<any>;
+
+    constructor();
+
+    private _initRecording;
+
+    private _onRecordedData;
+}

package/app/models/element/rewriter-element.model.d.ts

@@ -0,0 +1,23 @@
+// @ts-nocheck
+export declare class RewriterElement {
+  /**
+   * To enable rewriter feature
+   */
+  enableRewriter: () => void;
+
+  /**
+   * To disable rewriter feature
+   */
+  disableRewriter: () => void;
+  constructor();
+
+  /**
+   * To enable rewriter feature
+   */
+  private _enableRewriter;
+
+  /**
+   * To disable rewriter feature
+   */
+  private _disableRewriter;
+}

package/app/models/element/selection-element.model.d.ts

@@ -0,0 +1,15 @@
+// @ts-nocheck
+export declare class SelectionElement {
+    /**
+     * To enable/disable selections
+     * @param enable pass `true` to enable it, `false` to disable it.
+     */
+     enableLiveSelection: (enable: boolean) => void;
+    constructor();
+
+    /**
+    * To enable/disable selections
+    * @param enable pass `true` to enable it, `false` to disable it.
+    */
+    private _enableLiveSelection;
+}