@layers-app/editor 2.2.13 → 2.2.14

package/dist/index.d.ts

@@ -79,13 +79,13 @@ declare type CommentResolve = 'ACCEPTED' | 'REJECTED' | null | 'NONE';
 
 export declare const CREATE_TEMPLATE: LexicalCommand<unknown>;
 
-export declare const createMediaComponent: (imageNode: LexicalNode) => true | undefined;
+export declare const createMediaComponent: (imageNode: LexicalNode) => boolean;
 
 export { deleteNode }
 
 export { Dropzone }
 
-export declare const Editor: <USER_DATA extends object, CHILD_PAGE extends PageData>({ initialContent, onChange, outputFormat, mode, maxHeight, onBlur, onFocus, fetchUploadMedia, fileChunkUploadApi, fetchPromptResult, fetchSmartPastePrompt, fetchSmartPasteStreamPrompt, fetchDeleteMedia, fetchRestoreMedia, pageId, commentController, maxFileSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, linkablePages, language, shiftEnterInsertNewLine, editorRef, placeholder, plugins, onTrack, onCopySuccess, onCopyError, onImproveTheme, onImproveThemeRevert, }: EditorProps<USER_DATA, CHILD_PAGE>) => JSX_2.Element;
+export declare const Editor: <USER_DATA extends object, CHILD_PAGE extends PageData>({ initialContent, onChange, outputFormat, mode, maxHeight, onBlur, onFocus, fetchUploadMedia, fileChunkUploadApi, isOfficePreviewAvailable, onPreviewOffice, fetchPromptResult, fetchSmartPastePrompt, fetchSmartPasteStreamPrompt, fetchDeleteMedia, fetchRestoreMedia, pageId, commentController, maxFileSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, linkablePages, language, shiftEnterInsertNewLine, editorRef, placeholder, plugins, onTrack, onCopySuccess, onCopyError, mentionSearch, onMentionsChange, getMentionUserInfo, }: EditorProps<USER_DATA, CHILD_PAGE>) => JSX_2.Element;
 
 declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA extends PageData = PageData> {
     initialContent: Root | string;
@@ -97,6 +97,8 @@ declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA exten
     maxHeight?: number;
     fetchUploadMedia?: fetchUploadMedia;
     fileChunkUploadApi?: FileChunkUploadApi;
+    isOfficePreviewAvailable?: boolean;
+    onPreviewOffice?: OnPreviewOffice;
     fetchPromptResult?: fetchPromptResult;
     fetchSmartPastePrompt?: fetchPromptResult;
     fetchSmartPasteStreamPrompt?: fetchPromptStreamResult;
@@ -127,8 +129,9 @@ declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA exten
     onTrack?: EditorTrackFn;
     onCopySuccess?: (message: string) => void;
     onCopyError?: (message: string) => void;
-    onImproveTheme?: (icon: string, coverQuery: string) => void;
-    onImproveThemeRevert?: () => void;
+    mentionSearch?: MentionSearchFn;
+    onMentionsChange?: (mentions: MentionRef[]) => void;
+    getMentionUserInfo?: MentionUserInfoFn;
 }
 
 declare type EditorTrackFn = (event: string, params?: Record<string, unknown>) => void;
@@ -156,7 +159,7 @@ declare type ExcludeNodes = {
     [K in ExcludeNodesKey]?: boolean;
 };
 
-declare type ExcludeNodesKey = 'paragraph' | 'quote' | 'code' | 'table' | 'grid' | 'horizontal-rule' | 'caret-right' | 'emoji' | 'excalidraw' | 'childDocs' | 'photo' | 'video' | 'audio' | 'file' | 'embed' | 'form' | 'contents' | 'template' | 'componentPicker' | 'hashtag' | 'list' | 'check' | 'link' | 'comment' | 'swagger' | 'callout' | 'layout' | 'draggableBlock' | 'newParagraph' | 'actionMenu' | 'emptyPage' | 'previewCodeEquation' | '1' | '2' | '3' | 'number' | 'bullet' | 'default' | 'alert' | 'success' | 'warning' | 'images' | 'collapsible' | 'checkList' | 'horizontalRule' | 'inlinePageLink' | 'equation' | 'equation-inline' | 'pageLink' | 'codeHighlight' | 'smartPaste' | 'fastBackspace' | 'improveText' | 'extendCode' | 'keyboardSafeShortcuts' | 'toolbar' | 'select' | 'mediaActions';
+declare type ExcludeNodesKey = 'paragraph' | 'quote' | 'code' | 'table' | 'grid' | 'horizontal-rule' | 'caret-right' | 'emoji' | 'excalidraw' | 'childDocs' | 'photo' | 'video' | 'audio' | 'file' | 'embed' | 'form' | 'contents' | 'template' | 'componentPicker' | 'hashtag' | 'list' | 'check' | 'link' | 'comment' | 'swagger' | 'callout' | 'layout' | 'draggableBlock' | 'newParagraph' | 'actionMenu' | 'emptyPage' | '1' | '2' | '3' | 'number' | 'bullet' | 'default' | 'alert' | 'success' | 'warning' | 'images' | 'collapsible' | 'checkList' | 'horizontalRule' | 'inlinePageLink' | 'equation' | 'equation-inline' | 'pageLink' | 'codeHighlight' | 'smartPaste' | 'fastBackspace';
 
 export declare class ExtendMarkNode extends MarkNode implements ElementNode {
     __resolve: CommentResolve;
@@ -229,10 +232,43 @@ declare type ImagePickerSettings = {
     galleryCollection?: ImagePickerGalleryCollection[];
 };
 
+export declare type MentionRef = {
+    userId: string;
+    name: string;
+    anchorId?: string;
+    preview?: string;
+};
+
+export declare type MentionSearchFn = (trigger: string, query: string) => Promise<MentionUser[]>;
+
+export declare type MentionUser = {
+    value: string;
+    id: string;
+    avatarUrl?: string;
+};
+
+export declare type MentionUserInfoFn = (userId: string) => MentionUserPreview | Promise<MentionUserPreview | null> | null;
+
+export declare type MentionUserPreview = {
+    id: string;
+    name: string;
+    avatarUrl?: string;
+    roleLabel?: string;
+    isYou?: boolean;
+};
+
 declare type Mode = 'comment' | 'default' | 'editor';
 
 export { NodeKey }
 
+declare type OfficePreviewKind = 'word' | 'cell' | 'slide' | 'pdf';
+
+declare type OnPreviewOffice = (params: {
+    fileId: string;
+    kind: OfficePreviewKind;
+    name: string;
+}) => void;
+
 declare type outputFormat = 'html' | 'json';
 
 declare interface PageData {