diff --git a/README.md b/README.md index 596ec153..079552c3 100644 --- a/README.md +++ b/README.md @@ -446,6 +446,11 @@ Usage of SOARCA-GUI is described here: https://cossas.github.io/SOARCA/docs/ - The read-only diagram supports panning and step details. Use its zoom buttons to change the zoom. - Leaving the visual editor with unsaved changes asks for confirmation, including in-app navigation, reloads and closing the tab. +### JSON playbook editor + +- "Edit JSON", next to "Edit" on a playbook page or in a playbook card's menu, opens the raw playbook JSON in a text editor. +- The GUI checks that the text is valid JSON with the CACAO playbook fields it needs before it saves. SOARCA checks the rest when it receives the playbook. + ## Acknowledgements The visual playbook editor was written from scratch for SOARCA-GUI, using these projects as a reference for CACAO concepts: diff --git a/src/App.tsx b/src/App.tsx index 08b4d16a..ec3a5f34 100644 --- a/src/App.tsx +++ b/src/App.tsx @@ -13,6 +13,7 @@ import { SettingsPage } from "./pages/main-page/SettingsPage"; import { ExecutionDetailPage } from "./pages/main-page/monitoring-page/ExecutionDetailPage"; import { MonitoringPage } from "./pages/main-page/monitoring-page/MonitoringPage"; import { PlaybookCreatePage } from "./pages/main-page/playbooks-page/PlaybookCreatePage"; +import { PlaybookJsonEditPage } from "./pages/main-page/playbooks-page/PlaybookJsonEditPage"; import { PlaybooksPage } from "./pages/main-page/playbooks-page/PlaybooksPage"; import { PlaybookDetailPage } from "./pages/main-page/playbooks-page/playbook-detail-page/PlaybookDetailPage"; import { PATHS } from "./utils"; @@ -90,6 +91,10 @@ function App() { path={PATHS.PLAYBOOKS.EDIT} element={withSuspense()} /> + } + /> } /> diff --git a/src/pages/main-page/playbooks-page/PlaybookActionsMenu.tsx b/src/pages/main-page/playbooks-page/PlaybookActionsMenu.tsx index 96992801..d330f292 100644 --- a/src/pages/main-page/playbooks-page/PlaybookActionsMenu.tsx +++ b/src/pages/main-page/playbooks-page/PlaybookActionsMenu.tsx @@ -1,5 +1,6 @@ import { useMutation, useQueryClient } from "@tanstack/react-query"; import { + IconBraces, IconDotsVertical, IconFileCode, IconPencil, @@ -130,6 +131,16 @@ export const PlaybookActionsMenu: React.FC = ({ Edit + + navigate( + PATHS.PLAYBOOKS.EDIT_JSON.replace(":playbookId", playbook.id), + ) + } + > + + Edit JSON + { + const navigate = useNavigate(); + const queryClient = useQueryClient(); + const { playbookId = "" } = useParams(); + const detailPath = PATHS.PLAYBOOKS.DETAIL.replace(":playbookId", playbookId); + const [jsonContent, setJsonContent] = useState(null); + const [error, setError] = useState(""); + + const { + data: playbook, + isLoading, + isError, + error: queryError, + } = useQuery({ + queryKey: ["playbook", playbookId], + queryFn: () => getPlaybookById(playbookId), + enabled: !!playbookId, + refetchOnWindowFocus: false, + }); + + const updateMutation = useMutation({ + mutationFn: (data: Playbook) => updatePlaybook(playbookId, data), + onSuccess: () => { + toast.success("Playbook updated successfully!"); + queryClient.invalidateQueries({ queryKey: ["playbook", playbookId] }); + queryClient.invalidateQueries({ queryKey: ["playbooks"] }); + navigate(detailPath); + }, + onError: (err: Error) => { + setError(err.message || "Failed to update playbook"); + toast.error(formatErrorForToast(err, "Failed to update playbook")); + }, + }); + + const initialJsonContent = useMemo( + () => (playbook ? JSON.stringify(playbook, null, 2) : ""), + [playbook], + ); + const currentContent = jsonContent ?? initialJsonContent; + + const handleChange = (value: string) => { + setJsonContent(value); + const validation = validatePlaybookJson(value); + setError(validation.valid ? "" : validation.error || "Invalid JSON"); + }; + + const handleSubmit = () => { + const validation = validatePlaybookJson(currentContent); + if (!validation.valid || !validation.data) { + setError(validation.error || "Invalid JSON"); + return; + } + setError(""); + updateMutation.mutate(validation.data); + }; + + const hasChanges = currentContent.trim() !== initialJsonContent.trim(); + const canSubmit = hasChanges && !error && !updateMutation.isPending; + + return ( + + + + Back to playbook + + + + + Edit playbook JSON: {playbook?.name ?? "..."} + + + {isLoading ? ( + + + + ) : isError || !playbook ? ( + + {isError + ? getErrorFromApiResponse(queryError)?.message || + "Could not load playbook" + : "Playbook not found"} + + ) : ( + <> + + Edit the playbook JSON below. The GUI checks it before saving. + + + {error && {error}} + + + + + + )} + + + + ); +}; diff --git a/src/pages/main-page/playbooks-page/playbook-detail-page/PlaybookDetailPage.tsx b/src/pages/main-page/playbooks-page/playbook-detail-page/PlaybookDetailPage.tsx index 01d894b2..500a469b 100644 --- a/src/pages/main-page/playbooks-page/playbook-detail-page/PlaybookDetailPage.tsx +++ b/src/pages/main-page/playbooks-page/playbook-detail-page/PlaybookDetailPage.tsx @@ -1,6 +1,7 @@ import { useMutation, useQuery } from "@tanstack/react-query"; import { IconArrowLeft, + IconBraces, IconFileCode, IconPencil, IconPlayerPlay, @@ -152,6 +153,18 @@ export const PlaybookDetailPage: React.FC = () => { Edit +