@veltdev/sdk-staging 4.5.2-beta.2 → 4.5.2-beta.20

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

@@ -29,7 +29,7 @@ import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
 import { CoreEventTypesMap } from "../models/data/core-events.data.model";
 import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } from "../models/data/document.data.model";
 import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
-import { UserDataProvider } from "../models/data/user-resolver.data.model";
+import { UserDataProvider, GetUserPermissionsRequest, GetUserPermissionsResponse } from "../models/data/user-resolver.data.model";
 import { VeltDataProvider } from "../models/data/provider.data.model";
 import { VeltEncryptionProvider } from "../models/data/encryption-provider.data.model";
 import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
@@ -277,6 +277,11 @@ export declare class Snippyly {
     */
    getUserRole$: () => Observable<string | null>;
 
+   /**
+    * To get user permissions.
+    */
+   getUserPermissions: (request?: GetUserPermissionsRequest) => Promise<GetUserPermissionsResponse>;
+
    /**
     * To check if plan is expired or not.
     */

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

@@ -8,6 +8,7 @@ export declare class AutocompleteData {
     description?: string;
     type: 'custom' | 'contact' | 'group';
     data: AutocompleteItem[];
+    groups?: AutocompleteGroup[];
 }
 export declare class AutocompleteItem {
     id: string;
@@ -18,6 +19,7 @@ export declare class AutocompleteItem {
         svg?: string;
     };
     link?: string;
+    groupId?: string;
 }
 export declare class AutocompleteReplaceData {
     text: string;
@@ -34,6 +36,10 @@ export declare class AutocompleteUserContactReplaceData {
     userId: string;
     contact?: UserContact;
 }
+export declare class AutocompleteGroup {
+    id: string;
+    name: string;
+}
 export declare class AutocompleteChipData extends AutocompleteItem {
     type: 'contact' | 'custom';
 }

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

@@ -17,6 +17,12 @@ export declare class CommentAnnotation {
      * Auto generated.
      */
     annotationId: string;
+    /**
+     * Annotation number for the comment pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationNumber?: number;
     /**
      * This is the list of all comments part of this annotation.
      *

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

@@ -79,6 +79,7 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
     [CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
     [CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
+    [CommentEventTypes.LINK_CLICKED]: LinkClickedEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -250,3 +251,10 @@ export interface ComposerClickedEvent {
     commentAnnotation?: CommentAnnotation;
     metadata?: VeltEventMetadata;
 }
+export interface LinkClickedEvent {
+    text: string;
+    link: string;
+    commentAnnotation: CommentAnnotation;
+    commentId: Number;
+    metadata?: VeltEventMetadata;
+}

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

@@ -1,4 +1,5 @@
 import { SingleEditorState, SingleEditorStatus } from "../../utils/enums";
+import { ErrorEvent } from "./core-events.data.model";
 import { User } from "./user.data.model";
 export declare class LiveStateData {
     /**
@@ -72,3 +73,20 @@ export declare class EditorAccessTimer {
 export declare class LiveStateDataConfig {
     listenToNewChangesOnly?: boolean;
 }
+export interface SetUserAsEditorResponse {
+    error?: ErrorEvent;
+}
+export interface LiveStateSingleEditorExternalUserPresence {
+    /**
+     * True if the same user is present on different tab.
+     */
+    sameUserPresentOnTab?: boolean;
+    /**
+     * True if the different user is present on different tab.
+     */
+    differentUserPresentOnTab?: boolean;
+    /**
+     * User ids of the users present on different tab.
+     */
+    userIds?: string[];
+}

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

@@ -12,8 +12,11 @@ export declare class UserIAM {
      */
     user: UserContact;
     documentIds?: string[];
+    viewerDocumentIds?: string[];
     folderIds?: string[];
+    viewerFolderIds?: string[];
     organizationIds?: string[];
+    viewerOrganizationIds?: string[];
     documentIdsCount?: number;
     folderIdsCount?: number;
     organizationIdsCount?: number;

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

@@ -5,3 +5,45 @@ export interface UserDataProvider {
     config?: ResolverConfig;
     resolveTimeout?: number;
 }
+export interface GetUserPermissionsRequest {
+    organizationId?: string;
+    folderIds?: string[];
+    documentIds?: string[];
+}
+export interface GetUserPermissionsResponse {
+    [userId: string]: {
+        folders?: {
+            [folderId: string]: {
+                accessRole?: UserPermissionAccessRole;
+                expiresAt?: number;
+                error?: string;
+                errorCode?: UserPermissionAccessRoleResult;
+            };
+        };
+        organization?: {
+            [organizationId: string]: {
+                accessRole?: UserPermissionAccessRole;
+                expiresAt?: number;
+                error?: string;
+                errorCode?: UserPermissionAccessRoleResult;
+            };
+        };
+        documents?: {
+            [documentId: string]: {
+                accessRole?: UserPermissionAccessRole;
+                expiresAt?: number;
+                error?: string;
+                errorCode?: UserPermissionAccessRoleResult;
+            };
+        };
+    };
+}
+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"
+}

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

@@ -1203,6 +1203,26 @@ export declare class CommentElement {
    */
   public disableFilterGhostCommentsInSidebar: () => void;
 
+  /**
+   * To enable link callback
+   */
+  public enableLinkCallback: () => void;
+
+  /**
+   * To disable link callback
+   */
+  public disableLinkCallback: () => void;
+
+  /**
+   * To enable full screen in sidebar
+   */
+  public enableFullScreenInSidebar: () => void;
+
+  /**
+   * To disable full screen in sidebar
+   */
+  public disableFullScreenInSidebar: () => void;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -2385,4 +2405,24 @@ export declare class CommentElement {
    * To disable filter ghost comments in sidebar
    */
   private _disableFilterGhostCommentsInSidebar;
-}
+
+  /**
+   * To enable link callback
+   */
+  private _enableLinkCallback;
+
+  /**
+   * To disable link callback
+   */
+  private _disableLinkCallback;
+
+  /**
+   * To enable full screen in sidebar
+   */
+  private _enableFullScreenInSidebar;
+
+  /**
+   * To disable full screen in sidebar
+   */
+  private _disableFullScreenInSidebar;
+}

package/app/models/element/live-state-sync-element.model.d.ts

@@ -1,8 +1,8 @@
 // @ts-nocheck
-import { SingleEditorConfig, UserEditorAccess, EditorAccessTimer, LiveStateDataConfig, SetLiveStateDataConfig } from '../data/live-state-data.data.model';
-import { User } from '../data/user.data.model';
 import { ServerConnectionState } from '../../utils/enums';
+import { EditorAccessTimer, LiveStateDataConfig, LiveStateSingleEditorExternalUserPresence, SetLiveStateDataConfig, SetUserAsEditorResponse, SingleEditorConfig, UserEditorAccess } from '../data/live-state-data.data.model';
 import { LiveStateEventTypesMap } from '../data/live-state-events.data.model';
+import { User } from '../data/user.data.model';
 
 /**
  * Represents the synchronization element for live state.
@@ -54,7 +54,7 @@ export declare class LiveStateSyncElement {
     /**
      * Sets the current user as an editor.
      */
-    setUserAsEditor: () => void;
+    setUserAsEditor: () => Promise<SetUserAsEditorResponse | void>;
 
     /**
      * Resets the user access.
@@ -142,6 +142,11 @@ export declare class LiveStateSyncElement {
      */
     onServerConnectionStateChange: () => Observable<ServerConnectionState>;
 
+    /**
+     * To update user presence for single editor mode
+     */
+    updateUserPresence: (userPresence: LiveStateSingleEditorExternalUserPresence) => void;
+
     /**
      * Subscribe to live state events
      */
@@ -285,6 +290,11 @@ export declare class LiveStateSyncElement {
      */
     private _onServerConnectionStateChange;
 
+    /**
+     * To update user presence for single editor mode
+     */
+    private _updateUserPresence;
+
     /**
      * Subscribe to live state events
      */

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

@@ -124,6 +124,36 @@ export declare class RecorderElement {
    */
   askDevicePermission: (options: RecorderDevicePermissionOptions) => void;
 
+  /**
+   * To set max length
+   */
+  setMaxLength: (seconds: number) => void;
+
+  /**
+   * To open picture in picture
+   */
+  openPictureInPicture: () => Promise<void>;
+
+  /**
+   * To exit picture in picture
+   */
+  exitPictureInPicture: () => Promise<void>;
+
+  /**
+   * To request screen permission
+   */
+  requestScreenPermission: () => Promise<MediaStream | null>;
+
+  /**
+   * To enable picture in picture
+   */
+  enablePictureInPicture: () => void;
+
+  /**
+   * To disable picture in picture
+   */
+  disablePictureInPicture: () => void;
+
   constructor();
 
   private _initRecording;
@@ -243,4 +273,34 @@ export declare class RecorderElement {
    * To ask device permission
    */
   private _askDevicePermission;
+
+  /**
+   * To set max length
+   */
+  private _setMaxLength;
+
+  /**
+   * To open picture in picture
+   */
+  private _openPictureInPicture;
+
+  /**
+   * To exit picture in picture
+   */
+  private _exitPictureInPicture;
+
+  /**
+   * To request screen permission
+   */
+  private _requestScreenPermission;
+
+  /**
+   * To enable picture in picture
+   */
+  private _enablePictureInPicture;
+
+  /**
+   * To disable picture in picture
+   */
+  private _disablePictureInPicture;
 }

package/app/utils/constants.d.ts

@@ -72,6 +72,7 @@ export declare class Constants {
     static DEFAULT_ANNOTATION_COLOR: string;
     static REGEX_EMAIL: RegExp;
     static REGEX_URL: RegExp;
+    static readonly REGEX_URL_FOR_USER_NAME: RegExp;
     static REGEX_SPECIAL_CHARS: RegExp;
     static SNIPPYLY_HIGHLIGHT: string;
     static SNIPPYLY_HIGHLIGHT_PREVIEW: string;

package/app/utils/enums.d.ts

@@ -54,6 +54,7 @@ export declare const CommentEventTypes: {
     readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
     readonly AUTOCOMPLETE_SEARCH: "autocompleteSearch";
     readonly COMPOSER_CLICKED: "composerClicked";
+    readonly LINK_CLICKED: "linkClicked";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-staging",
-    "version": "4.5.2-beta.2",
+    "version": "4.5.2-beta.20",
     "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": [