@veltdev/sdk-staging 5.0.4 → 6.0.0-beta.10

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

@@ -1,9 +1,8 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { Config, DisableLogsConfig } from "../models/data/config.data.model";
 import { DocumentUser } from "../models/data/document-user.data.model";
 import { Location } from "../models/data/location.model";
-import { User, UserOptions, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
+import { User, Options, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
 import { CustomCss } from "../models/data/custom-css.data.model";
 import { ActivityElement } from "../models/element/activity-element.model";
 import { AreaElement } from "../models/element/area-element.model";
@@ -24,7 +23,6 @@ import { TagElement } from "../models/element/tag-element.model";
 import { FeatureType } from "../utils/enums";
 import { UserContact } from "../models/data/user-contact.data.model";
 import { DocumentMetadata } from "../models/data/document-metadata.model";
-import { PageInfo } from "../models/data/page-info.model";
 import { ReactionElement } from "../models/element/reaction-element.model";
 import { CrdtElement } from "../models/element/crdt-element.model";
 import { VeltEventMetadata, VeltDebugInfo } from "../models/data/event-metadata.data.model";
@@ -41,7 +39,7 @@ import { HeartbeatConfig, Heartbeat, GetHeartbeatResponse } from "../models/data
 export declare class Snippyly {
    constructor();
    initConfig: (apiKey: string, config?: Config) => void;
-   identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
+   identify: (user: User, userOptions?: Options) => Promise<unknown>;
    setVeltAuthProvider: (veltAuthProvider: VeltAuthProvider) => Promise<User | null>;
    /**
     * Tell us who the currently logged in user is.
@@ -56,23 +54,6 @@ export declare class Snippyly {
     * @param documentMetadata Document Metadata
     */
    setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<void>;
-   /**
-    * Provide custom page info that the SDK should use instead of generating it from the browser
-    * (`window.location` / `document.title`). Newly created data (comments, reactions, recordings,
-    * presence, cursors, etc.) will use the provided page info. Already saved/existing data is not
-    * affected.
-    * @param pageInfo client-provided page info
-    * @param options optional; pass a `documentId` to scope the page info to a specific document
-    *                (per-document page info takes precedence over the global page info)
-    */
-   setPageInfo: (pageInfo: PageInfo, options?: { documentId?: string; }) => void;
-   /**
-    * Clear custom page info previously set via `setPageInfo`. The SDK will resume generating
-    * page info from the browser.
-    * @param options optional; pass a `documentId` to clear only that document's page info,
-    *                otherwise the global page info is cleared
-    */
-   clearPageInfo: (options?: { documentId?: string; }) => void;
    /**
     * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
     * @param id unique document ID

package/app/{models/data/arrow-annotation.data.model.d.ts → features/arrow/models/arrow-annotation.model.d.ts}

@@ -1,9 +1,9 @@
-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";
+import { AnnotationProperty } from "../../../models/data/annotation-property.data.model";
+import { CursorPosition } from "../../../models/data/cursor-position.data.model";
+import { Location } from "../../../models/data/location.model";
+import { PageInfo } from "../../../models/data/page-info.model";
+import { TargetElement } from "../../../models/data/target-element.data.model";
+import { User } from "../../../models/data/user.data.model";
 export declare class ArrowAnnotation {
     /**
      * Unique identifier for the arrow pin annotation.

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

@@ -0,0 +1,37 @@
+import { DocumentMetadata } from "../../../models/data/document-metadata.model";
+import { PageInfo } from "../../../models/data/page-info.model";
+import { User } from "../../../models/data/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/comment-events.data.model.d.ts

@@ -89,6 +89,10 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_TOOL_CLICKED]: CommentToolClickedEvent;
     [CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
     [CommentEventTypes.SIDEBAR_BUTTON_CLICKED]: SidebarButtonClickedEvent;
+    [CommentEventTypes.SIDEBAR_OPEN]: SidebarOpenEvent;
+    [CommentEventTypes.SIDEBAR_CLOSE]: SidebarCloseEvent;
+    [CommentEventTypes.COMMENT_CLICK]: CommentClickEvent;
+    [CommentEventTypes.COMMENT_NAVIGATION_BUTTON_CLICK]: CommentNavigationButtonClickEvent;
     [CommentEventTypes.ATTACHMENT_DOWNLOAD_CLICKED]: AttachmentDownloadClickedEvent;
     [CommentEventTypes.COMMENT_SAVED]: CommentSavedEvent;
     [CommentEventTypes.COMMENT_SAVE_TRIGGERED]: CommentSaveTriggeredEvent;
@@ -347,6 +351,31 @@ export interface SidebarButtonClickEvent {
 }
 export interface SidebarButtonClickedEvent extends SidebarButtonClickEvent {
 }
+/** Fired when the comment sidebar opens. Subscribe via `commentElement.on('sidebarOpen')`. */
+export interface SidebarOpenEvent {
+    metadata?: VeltEventMetadata;
+}
+/** Fired when the comment sidebar closes. Subscribe via `commentElement.on('sidebarClose')`. */
+export interface SidebarCloseEvent {
+    metadata?: VeltEventMetadata;
+}
+/** Fired when a comment is clicked in the sidebar list. Subscribe via `commentElement.on('commentClick')`. */
+export interface CommentClickEvent {
+    documentId?: string | null;
+    location?: Location | null;
+    targetElementId?: string | null;
+    context?: {
+        [key: string]: any;
+    };
+    annotation?: CommentAnnotation;
+    metadata?: VeltEventMetadata;
+}
+/**
+ * Fired when the navigation ("go to") button on a sidebar comment is clicked.
+ * Subscribe via `commentElement.on('commentNavigationButtonClick')`.
+ */
+export interface CommentNavigationButtonClickEvent extends CommentClickEvent {
+}
 export interface AttachmentDownloadClickedEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;

package/app/models/data/reaction-resolver.data.model.d.ts

@@ -39,4 +39,5 @@ export interface PartialReactionAnnotation {
     metadata?: BaseMetadata;
     icon?: string;
     from?: PartialUser;
+    [key: string]: any;
 }

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

@@ -21,14 +21,16 @@ export declare class Selection {
     pageInfo: PageInfo;
     timestamp: number;
 }
-export declare enum UserIndicatorPosition {
-    Start = "start",
-    End = "end"
-}
-export declare enum UserIndicatorType {
-    Avatar = "avatar",
-    Label = "label"
-}
+export declare const UserIndicatorPosition: {
+    readonly Start: "start";
+    readonly End: "end";
+};
+export type UserIndicatorPosition = (typeof UserIndicatorPosition)[keyof typeof UserIndicatorPosition];
+export declare const UserIndicatorType: {
+    readonly Avatar: "avatar";
+    readonly Label: "label";
+};
+export type UserIndicatorType = (typeof UserIndicatorType)[keyof typeof UserIndicatorType];
 export declare class LiveSelectionData {
     [userIdHash: string]: Selection;
 }

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

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

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

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

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

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

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

@@ -61,12 +61,14 @@ export interface GetUserPermissionsResponse {
         };
     };
 }
-export declare enum UserPermissionAccessRole {
-    EDITOR = "editor",
-    VIEWER = "viewer"
-}
-export declare enum UserPermissionAccessRoleResult {
-    DOES_NOT_EXIST = "does_not_exist",
-    PERMISSION_DENIED = "permission_denied",
-    SOMETHING_WENT_WRONG = "something_went_wrong"
-}
+export declare const UserPermissionAccessRole: {
+    readonly EDITOR: "editor";
+    readonly VIEWER: "viewer";
+};
+export type UserPermissionAccessRole = (typeof UserPermissionAccessRole)[keyof typeof UserPermissionAccessRole];
+export declare const UserPermissionAccessRoleResult: {
+    readonly DOES_NOT_EXIST: "does_not_exist";
+    readonly PERMISSION_DENIED: "permission_denied";
+    readonly SOMETHING_WENT_WRONG: "something_went_wrong";
+};
+export type UserPermissionAccessRoleResult = (typeof UserPermissionAccessRoleResult)[keyof typeof UserPermissionAccessRoleResult];

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

@@ -125,18 +125,20 @@ export interface VeltAuthProvider {
     generateToken?: () => Promise<string>;
     onError?: (err: unknown) => void;
 }
-export declare enum RevokeAccessOnType {
-    DOCUMENT_UNSET = "document_unset",
-    USER_LOGOUT = "user_logout"
-}
-export declare enum PermissionSource {
-    SET_DOCUMENTS = "setDocuments",
-    IDENTIFY = "identify",
-    GET_NOTIFICATIONS = "getNotifications",
-    SET_NOTIFICATIONS = "setNotifications",
-    REVOKE_ACCESS_ON_USER_LOGOUT = "revokeAccessOnUserLogout",
-    REVOKE_ACCESS_ON_DOCUMENT_UNSET = "revokeAccessOnDocumentUnset"
-}
+export declare const RevokeAccessOnType: {
+    readonly DOCUMENT_UNSET: "document_unset";
+    readonly USER_LOGOUT: "user_logout";
+};
+export type RevokeAccessOnType = (typeof RevokeAccessOnType)[keyof typeof RevokeAccessOnType];
+export declare const PermissionSource: {
+    readonly SET_DOCUMENTS: "setDocuments";
+    readonly IDENTIFY: "identify";
+    readonly GET_NOTIFICATIONS: "getNotifications";
+    readonly SET_NOTIFICATIONS: "setNotifications";
+    readonly REVOKE_ACCESS_ON_USER_LOGOUT: "revokeAccessOnUserLogout";
+    readonly REVOKE_ACCESS_ON_DOCUMENT_UNSET: "revokeAccessOnDocumentUnset";
+};
+export type PermissionSource = (typeof PermissionSource)[keyof typeof PermissionSource];
 export interface RevokeAccessOn {
     type: RevokeAccessOnType;
     revokeOrganizationAccess?: boolean;
@@ -192,12 +194,13 @@ export interface PermissionResolverRequest {
         requests: PermissionQuery[];
     };
 }
-export declare enum PermissionResourceType {
-    FOLDER = "folder",
-    DOCUMENT = "document",
-    ORGANIZATION = "organization",
-    CONTEXT = "context"
-}
+export declare const PermissionResourceType: {
+    readonly FOLDER: "folder";
+    readonly DOCUMENT: "document";
+    readonly ORGANIZATION: "organization";
+    readonly CONTEXT: "context";
+};
+export type PermissionResourceType = (typeof PermissionResourceType)[keyof typeof PermissionResourceType];
 export interface PermissionQuery {
     userId: string;
     resource: {

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { ActivityRecord, ActivitySubscribeConfig, CreateActivityData } from "../data/activity.data.model";
 

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 export declare class AreaElement {
     /**
      * To enable area feature

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

@@ -1,10 +1,9 @@
-// @ts-nocheck
 export declare class ArrowElement {
     /**
      * To allow arrow in specific elements only
      * @param elementIds Element ids to be allowed for arrow
      */
-    public allowedElementIds: (elementIds: string[]) => any;
+    public allowedElementIds: (elementIds: string[]) => void;
 
     constructor();
 

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

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Observable } from "rxjs";
 import { AutocompleteData, AutocompleteChipData } from "../data/autocomplete.data.model";
 export declare class AutocompleteElement {