@layers-app/editor 0.0.16 → 0.0.17-editor-01

package/dist/index.d.ts

@@ -1,10 +1,21 @@
+import { $getNodeByKey } from 'lexical';
 import { CLEAR_EDITOR_COMMAND } from 'lexical';
+import { DOMExportOutput } from 'lexical';
 import { Dropzone } from '@mantine/dropzone';
+import { EditorConfig } from 'lexical';
 import { LexicalEditor as EditorType } from 'lexical';
+import { ElementNode } from 'lexical';
 import { FOCUS_COMMAND } from 'lexical';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { MarkNode } from '@lexical/mark';
+import { NodeKey } from 'lexical';
+import { RangeSelection } from 'lexical';
 import { SerializedEditorState } from 'lexical';
+import { SerializedElementNode } from 'lexical';
 import { SerializedLexicalNode } from 'lexical';
+import { Spread } from 'lexical';
+
+export { $getNodeByKey }
 
 export declare type ActiveUserProfile<DATA extends object> = EditorUser<DATA> & {
     id: string;
@@ -12,9 +23,11 @@ export declare type ActiveUserProfile<DATA extends object> = EditorUser<DATA> &
 
 export { CLEAR_EDITOR_COMMAND }
 
+declare type CommentResolve = 'ACCEPTED' | 'REJECTED' | null;
+
 export { Dropzone }
 
-export declare const Editor: <USER_DATA extends object, CHILD_PAGE extends PageData>({ initialContent, onChange, outputFormat, mode, maxHeight, onBlur, onFocus, fetchUploadImage, fetchDeleteImage, maxImageSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, language, editorRef, }: 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, fetchUploadImage, fetchDeleteImage, currentUser, commentOptions, workspaceMembers, maxImageSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, language, editorRef, }: EditorProps<USER_DATA, CHILD_PAGE>) => JSX_2.Element;
 
 declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA extends PageData = PageData> {
     initialContent: Root | string;
@@ -29,6 +42,9 @@ declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA exten
     maxImageSize?: number;
     contentModalUploadImage?: React.FunctionComponent;
     maxImageSizeError?: () => void;
+    currentUser?: IUser;
+    commentOptions?: ICommentOptions;
+    workspaceMembers?: IMember[];
     debounce?: number;
     disable?: boolean;
     ws?: EditorWebSocketProps<USER_DATA>;
@@ -58,12 +74,109 @@ declare interface EditorWebSocketProps<USER_DATA extends object> {
 
 declare type ErrorDeleteImage = (error?: Error) => void;
 
+export declare class ExtendMarkNode extends MarkNode implements ElementNode {
+    __extendIds: string[];
+    __resolve: CommentResolve;
+    constructor(idsExtend: string[], resolve?: CommentResolve, key?: NodeKey);
+    static getType(): string;
+    static clone(node: ExtendMarkNode): ExtendMarkNode;
+    static importJSON(serializedNode: SerializedMarkNode): ExtendMarkNode;
+    static importDOM(): null;
+    resolveThreat(value: CommentResolve): CommentResolve;
+    createDOM(config: EditorConfig): HTMLElement;
+    exportDOM(editor: EditorType): DOMExportOutput;
+    updateDOM(prevNode: MarkNode, element: HTMLElement, config: EditorConfig): boolean;
+    exportJSON(): SerializedMarkNode;
+    excludeFromCopy(_destination: 'clone' | 'html'): boolean;
+    updateExtendId(tempId: string, realId: string): void;
+}
+
 declare type FetchDeleteImage = (id: string, success: SuccessDeleteImage, error?: ErrorDeleteImage) => void;
 
 declare type FetchUploadImage = (file: File, success: SuccessUploadImage, error?: ErrorDeleteImage) => void;
 
 export { FOCUS_COMMAND }
 
+declare interface ICommentActions {
+    fetchCommentsApi: (params: IFetchCommentsParams) => Promise<void>;
+    resolveCommentApi: (params: IResolveCommentParams) => Promise<void>;
+    commentReactionApi: (params: ICommentReactionParams) => Promise<void>;
+    deleteReactionApi: (params: IDeleteReactionParams) => Promise<void>;
+    deleteCommentApi: (params: IDeleteCommentParams) => Promise<void>;
+    restoreCommentApi: (params: IRestoreCommentParams) => Promise<void>;
+    updateCommentTextApi: (params: IUpdateCommentTextParams) => Promise<void>;
+    deleteCommentImageApi: (params: IDeleteCommentImageParams) => Promise<void>;
+    submitCommentApi: (params: ISubmitCommentParams) => Promise<void>;
+    getReactionsApi: (params: IGetReactionsParams) => Promise<{
+        content: ICommentReaction[];
+    }>;
+    getPhotosApi: (params: IGetPhotosParams) => Promise<File[]>;
+    uploadCommentFileApi: (params: IUploadCommentFileParams) => Promise<void>;
+}
+
+declare interface ICommentOptions {
+    showComments: boolean;
+    setShowComments: (value?: boolean) => void;
+    pageId: string;
+    workspaceInfo: {
+        title: string;
+        icon: string;
+    };
+    commentActions: ICommentActions;
+}
+
+declare interface ICommentReaction {
+    id: string;
+    commentId: string;
+    parentId: string;
+    parentType: 'COMMENT' | 'THREAD';
+    reaction: string;
+    userId: string;
+    createdAt: string;
+    deleted: boolean;
+    deletedAt: string;
+    version: number;
+}
+
+declare interface ICommentReactionParams {
+    commentId: string;
+    author: string;
+    emojiValue: string;
+    onSuccess?: (data: ICommentReaction) => void;
+    onError: () => void;
+}
+
+declare interface IDeleteCommentImageParams {
+    photoToRemove: string;
+    onSuccess?: () => void;
+}
+
+declare interface IDeleteCommentParams {
+    deleteCommentId: string;
+    onSuccess?: () => void;
+}
+
+declare interface IDeleteReactionParams {
+    reactionId: string;
+    onSuccess?: () => void;
+    onError: () => void;
+}
+
+declare interface IFetchCommentsParams {
+    fetchPageComments?: boolean;
+    pageId: string;
+    fetchCommentComments?: boolean;
+    onSuccess: (data: any) => void;
+}
+
+declare interface IGetPhotosParams {
+    commentId: string;
+}
+
+declare interface IGetReactionsParams {
+    commentId: string;
+}
+
 declare type ImagePickerSettings = {
     maxUploadFiles?: number;
     unsplashClientId?: string;
@@ -72,8 +185,79 @@ declare type ImagePickerSettings = {
     link?: boolean;
 };
 
+declare interface IMember {
+    accepted: boolean;
+    avatarUrl: string;
+    email: string;
+    expiresAt: string | null;
+    invitationId: string | null;
+    invitationToken: string | null;
+    name: string;
+    roleType: string;
+    roleId: string;
+    userId: string;
+}
+
+declare interface IResolveCommentParams {
+    threatId: string;
+    resolveValue: 'ACCEPTED' | 'REJECTED';
+    onSuccess?: () => void;
+    onError?: () => void;
+}
+
+declare interface IRestoreCommentParams {
+    commentId: string;
+    onSuccess?: () => void;
+}
+
+declare interface ISubmitCommentParams {
+    text: string;
+    parentType: string;
+    parentId: string;
+    onSuccess?: (data: any) => void;
+}
+
+declare interface IUpdateCommentTextParams {
+    commentId: string;
+    textValue: string;
+    onSuccess?: () => void;
+    onError?: () => void;
+}
+
+declare interface IUploadCommentFileParams {
+    file: File;
+    commentId: string;
+    onSuccess?: (data: any) => void;
+}
+
+declare interface IUser {
+    activeWorkspaceId: string;
+    createdAt: string;
+    darkMode: boolean;
+    email: string;
+    id: string;
+    lang: string;
+    metaData: {
+        cover: Record<string, any>;
+        about: string;
+        socialNetworks: any[];
+        fontFamily: string;
+    };
+    name: string;
+    nickname: string;
+    plan: 'FREE' | 'PRO' | 'BUSINESS' | string;
+    profilePicture: {
+        url: string;
+    };
+    timeZone: string | null;
+    twoFactorEnabled: boolean;
+    workspaces: any[];
+}
+
 declare type Mode = 'comment' | 'default' | 'full' | 'editor';
 
+export { NodeKey }
+
 declare type outputFormat = 'html' | 'json';
 
 declare interface PageData {
@@ -83,8 +267,14 @@ declare interface PageData {
     order: number;
 }
 
+export { RangeSelection }
+
 export declare type Root = SerializedEditorState<SerializedLexicalNode>;
 
+declare type SerializedMarkNode = Spread<{
+    ids: Array<string>;
+}, SerializedElementNode>;
+
 export declare const StylesProvider: ({ children }: {
     children: React.ReactNode;
 }) => JSX_2.Element;
@@ -94,3 +284,43 @@ declare type SuccessDeleteImage = () => void;
 declare type SuccessUploadImage = (url: string, id: string) => void;
 
 export { }
+
+
+declare global {
+    interface DragEvent {
+        rangeOffset?: number;
+        rangeParent?: Node;
+    }
+}
+
+
+declare global {
+    interface Navigator {
+        userAgentData?: {
+            mobile: boolean;
+        };
+    }
+}
+
+declare global {
+    interface Document {
+        documentMode?: unknown;
+    }
+    interface Window {
+        MSStream?: unknown;
+    }
+}
+
+
+declare global {
+    interface Window {
+        editorAppVersion: string;
+    }
+}
+
+
+declare global {
+    interface Window {
+        editorAppVersion: string;
+    }
+}