@veltdev/types 6.0.0-beta.1 → 6.0.0-beta.3

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

@@ -1,8 +1,8 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { PresenceUser } from "../data/presence-user.data.model";
 import { GetPresenceDataResponse, PresenceEventTypesMap } from "../data/presence-events.data.model";
 import { PresenceRequestQuery } from "../data/presence-actions.data.model";
+import { FlockOptions } from "../data/flock-options.model";
 
 export declare class PresenceElement {
 
@@ -21,15 +21,27 @@ export declare class PresenceElement {
     setInactivityTime: (time: number) => void;
 
     /**
-     * Enables follow along mode globally
-     * @param options {FollowOptions: {useHistoryAPI: boolean, onNavigate: (url: PageInfo) => void}}}
+     * Enable flock mode globally
+     * @param options FlockOptions
      */
-    enableFollowAlongMode: (useHistoryAPI: boolean) => any;
+    enableFlockMode: (options?: FlockOptions) => void;
 
     /**
-     * To disable follow along mode
+     * Disable flock mode globally
      */
-    disableFollowAlongMode: () => any;
+    disableFlockMode: () => void;
+
+    /**
+     * Start/join a flock session by following the given user
+     * @param userId The leader user ID
+     * @param name The leader user name
+     */
+    startFollowingUser: (userId: string, name: string) => void;
+
+    /**
+     * Exit the flock session / stop following
+     */
+    stopFollowingUser: () => void;
 
     /**
      * To enable adding self to the presence list
@@ -81,15 +93,24 @@ export declare class PresenceElement {
     private _setInactivityTime;
 
     /**
-     * Enables follow along mode globally
-     * @param options {FollowOptions: {useHistoryAPI: boolean, onNavigate: (url: PageInfo) => void}}}
+     * Enable flock mode globally
+     */
+    private _enableFlockMode;
+
+    /**
+     * Disable flock mode globally
+     */
+    private _disableFlockMode;
+
+    /**
+     * Start/join a flock session by following the given user
      */
-    private _enableFollowAlongMode;
+    private _startFollowingUser;
 
     /**
-     * To disable follow along mode
+     * Exit the flock session / stop following
      */
-    private _disableFollowAlongMode;
+    private _stopFollowingUser;
 
     /**
      * To enable adding self to the presence list

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

@@ -1,4 +1,4 @@
-// @ts-nocheck
+import { ReactionMap } from '../data/reaction-annotation.data.model';
 export { ReactionMap } from '../data/reaction-annotation.data.model';
 
 export declare class ReactionElement {

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse, GetRecordingsResponse, DeleteRecordingsResponse } from "../data/recorder-annotation.data.model";
 import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
@@ -6,13 +5,23 @@ import { RecordedData, RecorderQualityConstraints, RecorderEncodingOptions, Reco
 
 export declare class RecorderElement {
 
-    initRecording: (type: string, panelId?: string) => any;
+    initRecording: (type: string, panelId?: string) => Promise<void>;
 
     /**
      * @deprecated Use on('recordingDone') method instead
      */
     onRecordedData: () => Observable<RecordedData | null>;
 
+    /**
+     * To enable dark mode in recording
+     */
+    enableDarkMode: () => void;
+
+    /**
+     * To disable dark mode in recording
+     */
+    disableDarkMode: () => void;
+
     /**
      * To enable recording countdown
      */
@@ -173,6 +182,16 @@ export declare class RecorderElement {
      */
     private _onRecordedData;
 
+    /**
+     * To enable dark mode in recording
+     */
+    private _enableDarkMode;
+
+    /**
+     * To disable dark mode in recording
+     */
+    private _disableDarkMode;
+
     /**
      * To enable dark mode in comments
      */

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

@@ -1,4 +1,6 @@
-// @ts-nocheck
+import { Observable } from "rxjs";
+import { RewriterAskAiRequest, RewriterAskAiResponse, RewriterReplaceTextRequest, RewriterReplaceTextResponse, RewriterAddCommentRequest, RewriterAddCommentResponse, RewriterEventTypesMap } from "../data/rewriter-events.data.model";
+
 export declare class RewriterElement {
   /**
    * To enable rewriter feature
@@ -19,6 +21,26 @@ export declare class RewriterElement {
    * To disable the default rewriter UI on text selection
    */
   disableDefaultUI: () => void;
+
+  /**
+   * Subscribe to rewriter events
+   */
+  on: <T extends keyof RewriterEventTypesMap>(action: T) => Observable<RewriterEventTypesMap[T]>;
+
+  /**
+   * Call AI with the currently selected text
+   */
+  askAi: (request: RewriterAskAiRequest) => Promise<RewriterAskAiResponse>;
+
+  /**
+   * Replace the selected text in the DOM with the given text
+   */
+  replaceText: (request: RewriterReplaceTextRequest) => Promise<RewriterReplaceTextResponse>;
+
+  /**
+   * Add a comment annotation on the selected text with the given text as comment body
+   */
+  addComment: (request: RewriterAddCommentRequest) => Promise<RewriterAddCommentResponse>;
   constructor();
 
   /**
@@ -40,4 +62,24 @@ export declare class RewriterElement {
    * To disable the default rewriter UI on text selection
    */
   private _disableDefaultUI;
+
+  /**
+   * Subscribe to rewriter events
+   */
+  private _on;
+
+  /**
+   * Call AI with the currently selected text
+   */
+  private _askAi;
+
+  /**
+   * Replace the selected text in the DOM with the given text
+   */
+  private _replaceText;
+
+  /**
+   * Add a comment annotation on the selected text with the given text as comment body
+   */
+  private _addComment;
 }

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

@@ -1,4 +1,4 @@
-// @ts-nocheck
+import { Observable } from "rxjs";
 import { LiveSelectionData, UserIndicatorPosition, UserIndicatorType } from "../data/selection.model";
 export declare class SelectionElement {
     /**

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { SuggestionEventType } from "../../utils/enums";
 import { SuggestionEventTypesMap } from "../data/suggestion-events.data.model";

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

@@ -1,31 +1,30 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
-import { TagPinAnnotation } from "../data/tag-annotation.data.model";
+import { TagAnnotation } from "../data/tag-annotation.data.model";
 export declare class TagElement {
     /**
      * Subscribe to tags on the current document.
      * 
-     * Returns Observable<TagPinAnnotation[] | null>.
+     * Returns Observable<TagAnnotation[] | null>.
      */
-    getAllTagAnnotations: (documentId?: string, documentParams?: object) => Observable<TagPinAnnotation[] | null>;
+    getAllTagAnnotations: (documentId?: string, documentParams?: object) => Observable<TagAnnotation[] | null>;
 
     /**
      * To delete selected tags
      */
-    deleteTag: () => any;
+    deleteTag: () => void;
 
     /**
      * To allow text selection in specific elements only
      * @param elementIds Element ids to be allowed
      */
-    allowedElementIds: (elementIds: string[]) => any;
+    allowedElementIds: (elementIds: string[]) => void;
 
     /**
      * To add tags on specific elements
      * 
      * @param elementId ID of html element
      */
-    attachTag: (elementId: string) => any;
+    attachTag: (elementId: string) => void;
 
     /**
      * Subscribe to add tag mode change.
@@ -37,7 +36,7 @@ export declare class TagElement {
     /**
      * Subscribe to tags on the current document.
      * 
-     * Returns Observable<TagPinAnnotation[] | null>.
+     * Returns Observable<TagAnnotation[] | null>.
      */
     private _getAllTagAnnotations;
 

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

@@ -1,4 +1,4 @@
-// @ts-nocheck
+import { Observable } from "rxjs";
 import { ViewsByUser, ViewsByDate } from "../data/views.data.model";
 
 export declare class ViewsElement {

package/app/utils/enums.d.ts

@@ -1,38 +1,40 @@
-export declare enum CommentStatus {
-    NEWLY_ADDED = "newlyAdded",
-    ADDED = "added",
-    UPDATED = "updated",
-    DELETED = "deleted",
-    APPROVED = "approved",
-    ASSIGNED = "assigned",
-    STATUS_CHANGED = "statusChanged",
-    PRIORITY_CHANGED = "priorityChanged",
-    ACCESS_MODE_CHANGED = "accessModeChanged",
-    CUSTOM_LIST_CHANGED = "customListChanged",
-    ACCEPTED = "accepted",
-    REJECTED = "rejected",
-    REACTION_ADDED = "reactionAdded",
-    REACTION_DELETED = "reactionDeleted",
-    SUBSCRIBED = "subscribed",
-    UNSUBSCRIBED = "unsubscribed",
-    SUGGESTION_ACCEPTED = "suggestionAccepted",
-    SUGGESTION_REJECTED = "suggestionRejected"
-}
-export declare enum ResolverActions {
-    COMMENT_ANNOTATION_ADD = "comment_annotation.add",
-    COMMENT_ANNOTATION_DELETE = "comment_annotation.delete",
-    COMMENT_ADD = "comment.add",
-    COMMENT_DELETE = "comment.delete",
-    COMMENT_UPDATE = "comment.update",
-    REACTION_ADD = "reaction.add",
-    REACTION_DELETE = "reaction.delete",
-    ATTACHMENT_ADD = "attachment.add",
-    ATTACHMENT_DELETE = "attachment.delete",
-    RECORDER_ANNOTATION_ADD = "recorder_annotation.add",
-    RECORDER_ANNOTATION_UPDATE = "recorder_annotation.update",
-    RECORDER_ANNOTATION_DELETE = "recorder_annotation.delete",
-    ACTIVITY_SAVE = "activity.save"
-}
+export declare const CommentStatus: {
+    readonly NEWLY_ADDED: "newlyAdded";
+    readonly ADDED: "added";
+    readonly UPDATED: "updated";
+    readonly DELETED: "deleted";
+    readonly APPROVED: "approved";
+    readonly ASSIGNED: "assigned";
+    readonly STATUS_CHANGED: "statusChanged";
+    readonly PRIORITY_CHANGED: "priorityChanged";
+    readonly ACCESS_MODE_CHANGED: "accessModeChanged";
+    readonly CUSTOM_LIST_CHANGED: "customListChanged";
+    readonly ACCEPTED: "accepted";
+    readonly REJECTED: "rejected";
+    readonly REACTION_ADDED: "reactionAdded";
+    readonly REACTION_DELETED: "reactionDeleted";
+    readonly SUBSCRIBED: "subscribed";
+    readonly UNSUBSCRIBED: "unsubscribed";
+    readonly SUGGESTION_ACCEPTED: "suggestionAccepted";
+    readonly SUGGESTION_REJECTED: "suggestionRejected";
+};
+export type CommentStatus = (typeof CommentStatus)[keyof typeof CommentStatus];
+export declare const ResolverActions: {
+    readonly COMMENT_ANNOTATION_ADD: "comment_annotation.add";
+    readonly COMMENT_ANNOTATION_DELETE: "comment_annotation.delete";
+    readonly COMMENT_ADD: "comment.add";
+    readonly COMMENT_DELETE: "comment.delete";
+    readonly COMMENT_UPDATE: "comment.update";
+    readonly REACTION_ADD: "reaction.add";
+    readonly REACTION_DELETE: "reaction.delete";
+    readonly ATTACHMENT_ADD: "attachment.add";
+    readonly ATTACHMENT_DELETE: "attachment.delete";
+    readonly RECORDER_ANNOTATION_ADD: "recorder_annotation.add";
+    readonly RECORDER_ANNOTATION_UPDATE: "recorder_annotation.update";
+    readonly RECORDER_ANNOTATION_DELETE: "recorder_annotation.delete";
+    readonly ACTIVITY_SAVE: "activity.save";
+};
+export type ResolverActions = (typeof ResolverActions)[keyof typeof ResolverActions];
 /**
  * Opt-in additional (non-core) comment save events for the Comment Annotations Resolver
  * (specs/comment-resolver iteration-2). Values mirror the non-core `CommentActivityActionTypes`
@@ -42,22 +44,23 @@ export declare enum ResolverActions {
  * `ResolverActions`. Kept in enums.ts (a leaf module) to avoid a
  * resolver.data.model ↔ comment-resolver.data.model import cycle.
  */
-export declare enum CommentResolverSaveEvent {
-    STATUS_CHANGE = "comment_annotation.status_change",
-    PRIORITY_CHANGE = "comment_annotation.priority_change",
-    ASSIGN = "comment_annotation.assign",
-    ACCESS_MODE_CHANGE = "comment_annotation.access_mode_change",
-    CUSTOM_LIST_CHANGE = "comment_annotation.custom_list_change",
-    APPROVE = "comment_annotation.approve",
-    ACCEPT = "comment.accept",
-    REJECT = "comment.reject",
-    SUGGESTION_ACCEPT = "comment_annotation.suggestion_accept",
-    SUGGESTION_REJECT = "comment_annotation.suggestion_reject",
-    REACTION_ADD = "comment.reaction_add",
-    REACTION_DELETE = "comment.reaction_delete",
-    SUBSCRIBE = "comment_annotation.subscribe",
-    UNSUBSCRIBE = "comment_annotation.unsubscribe"
-}
+export declare const CommentResolverSaveEvent: {
+    readonly STATUS_CHANGE: "comment_annotation.status_change";
+    readonly PRIORITY_CHANGE: "comment_annotation.priority_change";
+    readonly ASSIGN: "comment_annotation.assign";
+    readonly ACCESS_MODE_CHANGE: "comment_annotation.access_mode_change";
+    readonly CUSTOM_LIST_CHANGE: "comment_annotation.custom_list_change";
+    readonly APPROVE: "comment_annotation.approve";
+    readonly ACCEPT: "comment.accept";
+    readonly REJECT: "comment.reject";
+    readonly SUGGESTION_ACCEPT: "comment_annotation.suggestion_accept";
+    readonly SUGGESTION_REJECT: "comment_annotation.suggestion_reject";
+    readonly REACTION_ADD: "comment.reaction_add";
+    readonly REACTION_DELETE: "comment.reaction_delete";
+    readonly SUBSCRIBE: "comment_annotation.subscribe";
+    readonly UNSUBSCRIBE: "comment_annotation.unsubscribe";
+};
+export type CommentResolverSaveEvent = (typeof CommentResolverSaveEvent)[keyof typeof CommentResolverSaveEvent];
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
     readonly ADD_COMMENT_ANNOTATION_DRAFT: "addCommentAnnotationDraft";
@@ -95,6 +98,10 @@ export declare const CommentEventTypes: {
     readonly COMMENT_TOOL_CLICKED: "commentToolClicked";
     readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
     readonly SIDEBAR_BUTTON_CLICKED: "sidebarButtonClicked";
+    readonly SIDEBAR_OPEN: "sidebarOpen";
+    readonly SIDEBAR_CLOSE: "sidebarClose";
+    readonly COMMENT_CLICK: "commentClick";
+    readonly COMMENT_NAVIGATION_BUTTON_CLICK: "commentNavigationButtonClick";
     readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
     readonly COMMENT_SAVED: "commentSaved";
     readonly COMMENT_SAVE_TRIGGERED: "commentSaveTriggered";
@@ -200,11 +207,12 @@ export declare enum ArrowStatus {
     UPDATED = "updated",
     DELETED = "deleted"
 }
-export declare enum AreaStatus {
-    ADDED = "added",
-    UPDATED = "updated",
-    DELETED = "deleted"
-}
+export declare const AreaStatus: {
+    readonly ADDED: "added";
+    readonly UPDATED: "updated";
+    readonly DELETED: "deleted";
+};
+export type AreaStatus = (typeof AreaStatus)[keyof typeof AreaStatus];
 export declare enum DocumentViewsStatus {
     FIRST_VIEWED = "firstViewed"
 }
@@ -277,19 +285,21 @@ export declare enum Roles {
     ADMIN = "Admin",
     COMMENTER = "Commenter"
 }
-export declare enum DocumentAccessType {
-    PUBLIC = "public",
-    RESTRICTED = "restricted",
-    ORGANIZATION_PRIVATE = "organizationPrivate"
-}
+export declare const DocumentAccessType: {
+    readonly PUBLIC: "public";
+    readonly RESTRICTED: "restricted";
+    readonly ORGANIZATION_PRIVATE: "organizationPrivate";
+};
+export type DocumentAccessType = (typeof DocumentAccessType)[keyof typeof DocumentAccessType];
 export declare enum DetectionStrategy {
     DEFAULT = "default",
     DYNAMIC_ID = "dynamicId"
 }
-export declare enum CommentAccessMode {
-    PUBLIC = "public",
-    PRIVATE = "private"
-}
+export declare const CommentAccessMode: {
+    readonly PUBLIC: "public";
+    readonly PRIVATE: "private";
+};
+export type CommentAccessMode = (typeof CommentAccessMode)[keyof typeof CommentAccessMode];
 export declare enum UnreadIndicatorMode {
     MINIMAL = "minimal",
     VERBOSE = "verbose"
@@ -302,19 +312,21 @@ export declare enum CommentCountType {
     TOTAL = "total",
     UNREAD = "unread"
 }
-export declare enum ServerConnectionState {
-    ONLINE = "online",
-    OFFLINE = "offline",
-    PENDING_INIT = "pendingInit",
-    PENDING_DATA = "pendingData"
-}
-export declare enum ContactListScopeForOrganizationUsers {
-    ALL = "all",
-    ORGANIZATION = "organization",
-    ORGANIZATION_USER_GROUP = "organizationUserGroup",
-    DOCUMENT = "document",
-    FOLDER = "folder"
-}
+export declare const ServerConnectionState: {
+    readonly ONLINE: "online";
+    readonly OFFLINE: "offline";
+    readonly PENDING_INIT: "pendingInit";
+    readonly PENDING_DATA: "pendingData";
+};
+export type ServerConnectionState = (typeof ServerConnectionState)[keyof typeof ServerConnectionState];
+export declare const ContactListScopeForOrganizationUsers: {
+    readonly ALL: "all";
+    readonly ORGANIZATION: "organization";
+    readonly ORGANIZATION_USER_GROUP: "organizationUserGroup";
+    readonly DOCUMENT: "document";
+    readonly FOLDER: "folder";
+};
+export type ContactListScopeForOrganizationUsers = (typeof ContactListScopeForOrganizationUsers)[keyof typeof ContactListScopeForOrganizationUsers];
 export type RecorderMode = 'audio' | 'video' | 'screen' | 'all' | string;
 export type RecorderType = 'audio' | 'video' | 'screen';
 export type RecorderFileFormat = 'mp3' | 'mp4' | 'webm';
@@ -354,10 +366,11 @@ export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFir
 export type NotificationPanelMode = 'popover' | 'sidebar';
 export type SidebarActionButtonType = 'default' | 'toggle';
 export type SidebarButtonCountType = 'default' | 'filter';
-export declare enum CommentSidebarSystemFiltersOperator {
-    AND = "and",
-    OR = "or"
-}
+export declare const CommentSidebarSystemFiltersOperator: {
+    readonly AND: "and";
+    readonly OR: "or";
+};
+export type CommentSidebarSystemFiltersOperator = (typeof CommentSidebarSystemFiltersOperator)[keyof typeof CommentSidebarSystemFiltersOperator];
 /**
  * Type for notification settings accordion types
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types",
-    "version": "6.0.0-beta.1",
+    "version": "6.0.0-beta.3",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [
@@ -38,5 +38,11 @@
     },
     "author": "",
     "license": "ISC",
-    "typings": "./velt.d.ts"
+    "typings": "./velt.d.ts",
+    "types": "./velt.d.ts",
+    "exports": {
+        ".": {
+            "types": "./velt.d.ts"
+        }
+    }
 }

package/types.d.ts

@@ -1,22 +1,22 @@
-export * from './app/client/snippyly.model';
-export * from './app/client/velt.model';
-export * from './app/models/element/area-element.model';
-export * from './app/models/element/arrow-element.model';
-export * from './app/models/element/comment-element.model';
-export * from './app/models/element/contact-element.model';
-export * from './app/models/element/cursor-element.model';
-export * from './app/models/element/huddle-element.model';
-export * from './app/models/element/live-state-sync-element.model';
-export * from './app/models/element/presence-element.model';
-export * from './app/models/element/recorder-element.model';
-export * from './app/models/element/rewriter-element.model';
-export * from './app/models/element/selection-element.model';
-export * from './app/models/element/tag-element.model';
-export * from './app/models/element/views-element.model';
-export * from './app/models/element/notification-element.model';
-export * from './app/models/element/autocomplete-element.model';
-export * from './app/models/element/reaction-element.model';
-export * from './app/models/element/crdt-element.model';
-export * from './app/models/element/activity-element.model';
-export * from './app/models/element/suggestion-element.model';
-export * from './models';
+export type * from './app/client/snippyly.model';
+export type * from './app/client/velt.model';
+export type * from './app/models/element/area-element.model';
+export type * from './app/models/element/arrow-element.model';
+export type * from './app/models/element/comment-element.model';
+export type * from './app/models/element/contact-element.model';
+export type * from './app/models/element/cursor-element.model';
+export type * from './app/models/element/huddle-element.model';
+export type * from './app/models/element/live-state-sync-element.model';
+export type * from './app/models/element/presence-element.model';
+export type * from './app/models/element/recorder-element.model';
+export type * from './app/models/element/rewriter-element.model';
+export type * from './app/models/element/selection-element.model';
+export type * from './app/models/element/tag-element.model';
+export type * from './app/models/element/views-element.model';
+export type * from './app/models/element/notification-element.model';
+export type * from './app/models/element/autocomplete-element.model';
+export type * from './app/models/element/reaction-element.model';
+export type * from './app/models/element/crdt-element.model';
+export type * from './app/models/element/activity-element.model';
+export type * from './app/models/element/suggestion-element.model';
+export type * from './models';

package/velt.d.ts

@@ -1,6 +1,5 @@
-// @ts-nocheck
 import * as velt from './types';
-export * from './types';
+export type * from './types';
 export type Velt = { init: (api: string, config: velt.Config) => Velt, loaded: boolean, loadVelt: Function, loadSnippyly: Function } & velt.Velt;
 export const Velt: {
     init: (api: string, config?: velt.Config) => Promise<Velt>,