@layers-app/editor 0.5.5 → 0.5.6-comment.1

package/dist/index.d.ts

@@ -26,13 +26,48 @@ export declare type ActiveUserProfile<DATA extends object> = EditorUser<DATA> &
 
 export { CLEAR_EDITOR_COMMAND }
 
+declare interface CommentActions {
+    add(params: {
+        text: string;
+        files: CommentAttachment[];
+    }, quote: string): Promise<string | void>;
+    delete(id: string): void;
+    restore(id: string): void;
+}
+
+declare interface CommentAttachment {
+    id: string;
+    name: string;
+    type: string;
+    size: number;
+    url: string;
+    src: string;
+    isImage: boolean;
+    isTemp: boolean;
+    raw?: File;
+}
+
+declare interface CommentController {
+    activeCommentId: {
+        id: string | null;
+        source: "editor" | "panel" | null;
+    };
+    onHighlight?: (id: string | null, source: "editor" | "panel") => void;
+    actions: CommentActions;
+    editorComments: Map<string, {
+        id: string;
+        deleted: boolean;
+        resolution: CommentResolve;
+    }>;
+}
+
 declare type CommentResolve = 'ACCEPTED' | 'REJECTED' | null | 'NONE';
 
 export declare const CREATE_TEMPLATE: LexicalCommand<unknown>;
 
 export { Dropzone }
 
-export declare const Editor: <USER_DATA extends object, CHILD_PAGE extends PageData>({ initialContent, onChange, outputFormat, mode, maxHeight, onBlur, onFocus, fetchUploadMedia, fetchPromptResult, fetchDeleteMedia, fetchRestoreMedia, currentUser, commentOptions, workspaceMembers, maxFileSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, language, shiftEnterInsertNewLine, 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, fetchUploadMedia, fetchPromptResult, fetchDeleteMedia, fetchRestoreMedia, pageId, commentController, maxFileSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, language, shiftEnterInsertNewLine, 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;
@@ -47,11 +82,10 @@ declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA exten
     fetchDeleteMedia?: fetchDeleteRestoreMedia;
     fetchRestoreMedia?: fetchDeleteRestoreMedia;
     maxFileSize?: number;
+    pageId?: string;
     contentModalUploadImage?: React.FunctionComponent;
     maxImageSizeError?: () => void;
-    currentUser?: IUser;
-    commentOptions?: ICommentOptions;
-    workspaceMembers?: IMember[];
+    commentController?: CommentController;
     debounce?: number;
     disable?: boolean;
     shiftEnterInsertNewLine?: boolean;
@@ -111,90 +145,6 @@ export { FOCUS_COMMAND }
 
 export declare function focusEditor(editor: EditorType, atStart?: boolean): void;
 
-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 & {
-        id: string;
-    })[]>;
-    uploadCommentFileApi: (params: IUploadCommentFileParams) => Promise<void>;
-}
-
-declare interface ICommentOptions {
-    showComments: boolean;
-    setShowComments: (value?: boolean) => void;
-    pageId: string;
-    adminPermission: boolean;
-    isGuest: boolean;
-    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;
@@ -203,75 +153,6 @@ declare type ImagePickerSettings = {
     link?: boolean;
 };
 
-declare interface IMember {
-    avatarUrl: string | null;
-    roleType: string;
-    roleId: string;
-    accepted: boolean;
-    email: string;
-    userId: string | null;
-    invitationId: string | null;
-    invitationToken: string | null;
-    name: string | null;
-    expiresAt: string | null;
-}
-
-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' | 'editor';
 
 export { NodeKey }