forked from github/plane
d511799f31
* feat: created custom mention component * feat: added mention suggestions and suggestion highlights * feat: created mention suggestion list for displaying mention suggestions * feat: created custom mention text component, for handling click event * feat: exposed mention component * feat: integrated and exposed `mentions` componenet with `editor-core` * feat: integrated mentions extension with the core editor package * feat: exposed suggestion types from mentions * feat: added `mention-suggestion` parameters in `r-t-e` and `l-t-e` * feat: added `IssueMention` model in apiserver models * chore: updated activities background job and added bs4 in requirements * feat: added mention removal logic in issue_activity * chore: exposed mention types from `r-t-e` and `l-t-e` * feat: integrated mentions in side peek view description form * feat: added mentions in issue modal form * feat: created custom react-hook for editor suggestions * feat: integrated mention suggestions block in RichTextEditor * feat: added `mentions` integration in `lite-text-editor` instances * fix: tailwind loading nodemodules from packages * feat: added styles for the mention suggestion list * fix: update module import to resolve build failure * feat: added mentions as an issue filter * feat: added UI Changes to Implement `mention` filters * feat: added `mentions` as a filter option in the header * feat: added mentions in the filter list options * feat: added mentions in default display filter options * feat: added filters in applied and issue params in store * feat: modified types for adding mentions as a filter option * feat: modified `notification-card` to display message when it exists in object * feat: rewrote user mention management upon the changes made in develop * chore: merged debounce PR with the current PR for tracing changes * fix: mentions_filters updated with the new setup * feat: updated requirements for bs4 * feat: modified `mentions-filter` to remove many to many dependency * feat: implemented list manipulation instead of for loop * feat: added readonly functionality in `read-only` editor core * feat: added UI Changes for read-only mode * feat: added mentions store in web Root Store * chore: renamed `use-editor-suggestions` hook * feat: UI Improvements for conditional highlights w.r.t readonly in mentionNode * fix: removed mentions from `filter_set` parameters * fix: minor merge fixes * fix: package lock updates --------- Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com>
400 lines
13 KiB
TypeScript
400 lines
13 KiB
TypeScript
import { useCallback, useEffect, useState, FC, Dispatch, SetStateAction, useRef } from "react";
|
|
import { useRouter } from "next/router";
|
|
import { mutate } from "swr";
|
|
import { Sparkle } from "lucide-react";
|
|
import { Controller, useForm } from "react-hook-form";
|
|
// services
|
|
import { PageService } from "services/page.service";
|
|
import { IssueService } from "services/issue/issue.service";
|
|
import { AIService } from "services/ai.service";
|
|
import { FileService } from "services/file.service";
|
|
// hooks
|
|
import useToast from "hooks/use-toast";
|
|
// components
|
|
import { GptAssistantModal } from "components/core";
|
|
import { Button, TextArea } from "@plane/ui";
|
|
import { RichTextEditorWithRef } from "@plane/rich-text-editor";
|
|
// types
|
|
import { IUser, IPageBlock } from "types";
|
|
// fetch-keys
|
|
import { PAGE_BLOCKS_LIST } from "constants/fetch-keys";
|
|
import useEditorSuggestions from "hooks/use-editor-suggestions";
|
|
|
|
type Props = {
|
|
handleClose: () => void;
|
|
data?: IPageBlock;
|
|
handleAiAssistance?: (response: string) => void;
|
|
setIsSyncing?: Dispatch<SetStateAction<boolean>>;
|
|
focus?: keyof IPageBlock;
|
|
user: IUser | undefined;
|
|
};
|
|
|
|
const defaultValues = {
|
|
name: "",
|
|
description: null,
|
|
description_html: null,
|
|
};
|
|
|
|
const aiService = new AIService();
|
|
const pagesService = new PageService();
|
|
const issueService = new IssueService();
|
|
const fileService = new FileService();
|
|
|
|
export const CreateUpdateBlockInline: FC<Props> = ({
|
|
handleClose,
|
|
data,
|
|
handleAiAssistance,
|
|
setIsSyncing,
|
|
focus,
|
|
user,
|
|
}) => {
|
|
const [iAmFeelingLucky, setIAmFeelingLucky] = useState(false);
|
|
const [gptAssistantModal, setGptAssistantModal] = useState(false);
|
|
|
|
const editorRef = useRef<any>(null);
|
|
|
|
const router = useRouter();
|
|
const { workspaceSlug, projectId, pageId } = router.query;
|
|
|
|
const editorSuggestion = useEditorSuggestions(workspaceSlug as string | undefined, projectId as string | undefined)
|
|
|
|
const { setToastAlert } = useToast();
|
|
|
|
const {
|
|
handleSubmit,
|
|
control,
|
|
watch,
|
|
setValue,
|
|
setFocus,
|
|
reset,
|
|
formState: { errors, isSubmitting },
|
|
} = useForm<IPageBlock>({
|
|
defaultValues,
|
|
});
|
|
|
|
const onClose = useCallback(() => {
|
|
if (data) handleClose();
|
|
|
|
reset();
|
|
}, [handleClose, reset, data]);
|
|
|
|
const createPageBlock = useCallback(
|
|
async (formData: Partial<IPageBlock>) => {
|
|
if (!workspaceSlug || !projectId || !pageId) return;
|
|
|
|
await pagesService
|
|
.createPageBlock(
|
|
workspaceSlug as string,
|
|
projectId as string,
|
|
pageId as string,
|
|
{
|
|
name: formData.name,
|
|
description: formData.description ?? "",
|
|
description_html: formData.description_html ?? "<p></p>",
|
|
},
|
|
user
|
|
)
|
|
.then((res) => {
|
|
mutate<IPageBlock[]>(
|
|
PAGE_BLOCKS_LIST(pageId as string),
|
|
(prevData) => [...(prevData as IPageBlock[]), res],
|
|
false
|
|
);
|
|
editorRef.current?.clearEditor();
|
|
})
|
|
.catch(() => {
|
|
setToastAlert({
|
|
type: "error",
|
|
title: "Error!",
|
|
message: "Page could not be created. Please try again.",
|
|
});
|
|
})
|
|
.finally(() => onClose());
|
|
},
|
|
[workspaceSlug, projectId, pageId, onClose, setToastAlert, user]
|
|
);
|
|
|
|
const updatePageBlock = useCallback(
|
|
async (formData: Partial<IPageBlock>) => {
|
|
if (!workspaceSlug || !projectId || !pageId || !data) return;
|
|
|
|
if (data.issue && data.sync && setIsSyncing) setIsSyncing(true);
|
|
|
|
mutate<IPageBlock[]>(
|
|
PAGE_BLOCKS_LIST(pageId as string),
|
|
(prevData) =>
|
|
prevData?.map((p) => {
|
|
if (p.id === data.id) return { ...p, ...formData };
|
|
|
|
return p;
|
|
}),
|
|
false
|
|
);
|
|
|
|
await pagesService
|
|
.patchPageBlock(
|
|
workspaceSlug as string,
|
|
projectId as string,
|
|
pageId as string,
|
|
data.id,
|
|
{
|
|
name: formData.name,
|
|
description: formData.description,
|
|
description_html: formData.description_html,
|
|
},
|
|
user
|
|
)
|
|
.then((res) => {
|
|
mutate(PAGE_BLOCKS_LIST(pageId as string));
|
|
editorRef.current?.setEditorValue(res.description_html);
|
|
if (data.issue && data.sync)
|
|
issueService
|
|
.patchIssue(
|
|
workspaceSlug as string,
|
|
projectId as string,
|
|
data.issue,
|
|
{
|
|
name: res.name,
|
|
description: res.description,
|
|
description_html: res.description_html,
|
|
},
|
|
user
|
|
)
|
|
.finally(() => {
|
|
if (setIsSyncing) setIsSyncing(false);
|
|
});
|
|
})
|
|
.finally(() => onClose());
|
|
},
|
|
[workspaceSlug, projectId, pageId, data, onClose, setIsSyncing, user]
|
|
);
|
|
|
|
const handleAutoGenerateDescription = async () => {
|
|
if (!workspaceSlug || !projectId) return;
|
|
|
|
setIAmFeelingLucky(true);
|
|
|
|
aiService
|
|
.createGptTask(
|
|
workspaceSlug as string,
|
|
projectId as string,
|
|
{
|
|
prompt: watch("name"),
|
|
task: "Generate a proper description for this issue.",
|
|
},
|
|
user
|
|
)
|
|
.then((res) => {
|
|
if (res.response === "")
|
|
setToastAlert({
|
|
type: "error",
|
|
title: "Error!",
|
|
message:
|
|
"Block title isn't informative enough to generate the description. Please try with a different title.",
|
|
});
|
|
else {
|
|
setValue("description", {});
|
|
setValue("description_html", `${watch("description_html") ?? ""}<p>${res.response}</p>`);
|
|
editorRef.current?.setEditorValue(watch("description_html") ?? "");
|
|
}
|
|
})
|
|
.catch((err) => {
|
|
if (err.status === 429)
|
|
setToastAlert({
|
|
type: "error",
|
|
title: "Error!",
|
|
message: "You have reached the maximum number of requests of 50 requests per month per user.",
|
|
});
|
|
else
|
|
setToastAlert({
|
|
type: "error",
|
|
title: "Error!",
|
|
message: "Some error occurred. Please try again.",
|
|
});
|
|
})
|
|
.finally(() => setIAmFeelingLucky(false));
|
|
};
|
|
|
|
useEffect(() => {
|
|
if (focus) setFocus(focus);
|
|
|
|
if (!data) return;
|
|
|
|
reset({
|
|
...defaultValues,
|
|
name: data.name,
|
|
description:
|
|
!data.description || data.description === ""
|
|
? {
|
|
type: "doc",
|
|
content: [{ type: "paragraph" }],
|
|
}
|
|
: data.description,
|
|
description_html: data.description_html ?? "<p></p>",
|
|
});
|
|
}, [reset, data, focus, setFocus]);
|
|
|
|
useEffect(() => {
|
|
window.addEventListener("keydown", (e: KeyboardEvent) => {
|
|
if (e.key === "Escape") handleClose();
|
|
});
|
|
|
|
return () => {
|
|
window.removeEventListener("keydown", (e: KeyboardEvent) => {
|
|
if (e.key === "Escape") handleClose();
|
|
});
|
|
};
|
|
}, [handleClose]);
|
|
|
|
useEffect(() => {
|
|
const submitForm = (e: KeyboardEvent) => {
|
|
if ((e.ctrlKey || e.metaKey) && e.key === "Enter") {
|
|
if (data) handleSubmit(updatePageBlock)();
|
|
else handleSubmit(createPageBlock)();
|
|
}
|
|
};
|
|
|
|
window.addEventListener("keydown", submitForm);
|
|
|
|
return () => {
|
|
window.removeEventListener("keydown", submitForm);
|
|
};
|
|
}, [createPageBlock, updatePageBlock, data, handleSubmit]);
|
|
|
|
return (
|
|
<div className="relative">
|
|
<form
|
|
className="divide-y divide-custom-border-200 rounded border border-custom-border-200 shadow"
|
|
onSubmit={data ? handleSubmit(updatePageBlock) : handleSubmit(createPageBlock)}
|
|
>
|
|
<div className="pt-2">
|
|
<div className="flex justify-between">
|
|
<Controller
|
|
name="name"
|
|
control={control}
|
|
render={({ field: { value, onChange } }) => (
|
|
<TextArea
|
|
id="name"
|
|
name="name"
|
|
value={value}
|
|
placeholder="Title"
|
|
onChange={onChange}
|
|
className="min-h-10 font medium block w-full resize-none overflow-hidden border-none bg-transparent py-1 text-base"
|
|
autoComplete="off"
|
|
maxLength={255}
|
|
hasError={Boolean(errors?.name)}
|
|
/>
|
|
)}
|
|
/>
|
|
</div>
|
|
<div className="page-block-section relative -mt-2 text-custom-text-200">
|
|
<Controller
|
|
name="description_html"
|
|
control={control}
|
|
render={({ field: { value, onChange } }) => {
|
|
if (!data)
|
|
return (
|
|
<RichTextEditorWithRef
|
|
uploadFile={fileService.getUploadFileFunction(workspaceSlug as string)}
|
|
deleteFile={fileService.deleteImage}
|
|
ref={editorRef}
|
|
value={"<p></p>"}
|
|
debouncedUpdatesEnabled={false}
|
|
customClassName="text-sm"
|
|
noBorder
|
|
borderOnFocus={false}
|
|
onChange={(description: Object, description_html: string) => {
|
|
onChange(description_html);
|
|
setValue("description", description);
|
|
}}
|
|
mentionHighlights={editorSuggestion.mentionHighlights}
|
|
mentionSuggestions={editorSuggestion.mentionSuggestions}
|
|
/>
|
|
);
|
|
else if (!value || !watch("description_html"))
|
|
return <div className="h-32 w-full flex items-center justify-center text-custom-text-200 text-sm" />;
|
|
|
|
return (
|
|
<RichTextEditorWithRef
|
|
uploadFile={fileService.getUploadFileFunction(workspaceSlug as string)}
|
|
deleteFile={fileService.deleteImage}
|
|
ref={editorRef}
|
|
value={
|
|
value && value !== "" && Object.keys(value).length > 0
|
|
? value
|
|
: { type: "doc", content: [{ type: "paragraph" }] }
|
|
}
|
|
debouncedUpdatesEnabled={false}
|
|
customClassName="text-sm"
|
|
noBorder
|
|
borderOnFocus={false}
|
|
onChange={(description: Object, description_html: string) => {
|
|
onChange(description_html);
|
|
setValue("description", description);
|
|
}}
|
|
/>
|
|
);
|
|
}}
|
|
/>
|
|
<div className="m-2 mt-6 flex">
|
|
<button
|
|
type="button"
|
|
className={`flex items-center gap-1 rounded px-1.5 py-1 text-xs hover:bg-custom-background-80 ${
|
|
iAmFeelingLucky ? "cursor-wait bg-custom-background-90" : ""
|
|
}`}
|
|
onClick={handleAutoGenerateDescription}
|
|
disabled={iAmFeelingLucky}
|
|
>
|
|
{iAmFeelingLucky ? (
|
|
"Generating response..."
|
|
) : (
|
|
<>
|
|
<Sparkle className="h-4 w-4" />I{"'"}m feeling lucky
|
|
</>
|
|
)}
|
|
</button>
|
|
|
|
<button
|
|
type="button"
|
|
className="ml-2 flex items-center gap-1 rounded px-1.5 py-1 text-xs hover:bg-custom-background-80"
|
|
onClick={() => setGptAssistantModal(true)}
|
|
>
|
|
<Sparkle className="h-4 w-4" />
|
|
AI
|
|
</button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div className="flex items-center justify-end gap-2 p-4">
|
|
<Button variant="neutral-primary" onClick={handleClose}>
|
|
Cancel
|
|
</Button>
|
|
<Button variant="primary" type="submit" disabled={watch("name") === ""} loading={isSubmitting}>
|
|
{data ? (isSubmitting ? "Updating..." : "Update block") : isSubmitting ? "Adding..." : "Add block"}
|
|
</Button>
|
|
</div>
|
|
</form>
|
|
<GptAssistantModal
|
|
block={data ? data : undefined}
|
|
isOpen={gptAssistantModal}
|
|
handleClose={() => setGptAssistantModal(false)}
|
|
inset="top-8 left-0"
|
|
content={watch("description_html")}
|
|
htmlContent={watch("description_html")}
|
|
onResponse={(response) => {
|
|
if (data && handleAiAssistance) {
|
|
handleAiAssistance(response);
|
|
editorRef.current?.setEditorValue(`${watch("description_html")}<p>${response}</p>` ?? "");
|
|
} else {
|
|
setValue("description", {});
|
|
setValue("description_html", `${watch("description_html")}<p>${response}</p>`);
|
|
|
|
editorRef.current?.setEditorValue(watch("description_html") ?? "");
|
|
}
|
|
}}
|
|
projectId={projectId?.toString() ?? ""}
|
|
/>
|
|
</div>
|
|
);
|
|
};
|