import React, { useEffect, useLayoutEffect, useRef, useState } from "react" import { toast } from 'react-toastify'; import Markdown from 'react-markdown' import theme from '../theme.jsx'; import ReactJson from "react-json-view"; import { isMobile } from "react-device-detect"; import { BrowserView, MobileView } from "react-device-detect"; import { useParams, useNavigate, Link } from "react-router-dom"; import { validateJson, GetIconInfo } from "../views/Workflows.jsx"; import { Grid, TextField, IconButton, Tooltip, Divider, Button, Menu, MenuItem, Typography, Paper, List, Collapse, ListItemButton, ListItemText } from "@mui/material"; import { Link as LinkIcon, Edit as EditIcon, KeyboardArrowRight as KeyboardArrowRightIcon, ExpandMore as ExpandMoreIcon, FileCopy as FileCopyIcon } from "@mui/icons-material"; import { fontGrid } from "@mui/material/styles/cssUtils.js"; import { active } from "d3"; const Body = { //maxWidth: 1000, //minWidth: 768, maxWidth: "100%", minWidth: "100%", display: "flex", height: "100%", color: "white", position: "relative", //textAlign: "center", }; const dividerColor = "rgb(225, 228, 232)"; const hrefStyle = { color: "rgba(255, 255, 255, 0.8)", textDecoration: "none", }; const hrefStyleToc2 = { color: "rgba(255, 255, 255, 0.6)", textDecoration: "none", fontSize: "14px", fontWeight: 400, padding: "4px 0", paddingLeft: "12px", paddingRight: "12px", lineHeight: "20px", }; const hrefStyle2 = { color: "#f86a3e", textDecoration: "none", }; const innerHrefStyle = { color: "rgba(255, 255, 255, 0.75)", textDecoration: "none", }; export const CopyToClipboard = (props) => { const { text, style, onCopy } = props; const parsedstyle = style !== undefined ? style : { position: "absolute", right: 0, top: -10, } return (
{ navigator.clipboard.writeText(text); toast("Copied to clipboard") }} >
) } export const Paragrah = (props) => { const element = React.createElement( `p`, {}, props.children, ) if (props.children[0] != undefined) { if(typeof props.children[0] === "string") { if (props.children[0].includes('.mp4')) { return (
) } } } return (
{element}
) } export const OuterLink = (props) => { if (props.href.includes("http") || props.href.includes("mailto")) { return ( {props.children} ); } return ( {props.children} ); } export const Img = (props) => { return {props.alt}; } export const CodeHandler = (props) => { const propvalue = props.value !== undefined && props.value !== null ? props.value : props.children !== undefined && props.children !== null && props.children.length > 0 ? props.children[0] : "" const validate = validateJson(propvalue) var newprop = propvalue if (validate.valid === false) { // Check if https://shuffler.io in the url // if so, then we change it for the current url if (propvalue.includes("https://shuffler.io")) { newprop = propvalue.replace("https://shuffler.io", window.location.origin) } // Check if it contains Bearer APIKEY // If so, replace apikey //if (newprop.includes("Bearer APIKEY")) { // newprop = newprop.replace("Bearer APIKEY", "Bearer API //} } // Need to check if it's singletick or multi if (props.inline === true) { // Show it inline return ( {newprop} ) } return (
{validate.valid === true ? :
{newprop}
}
) } const Docs = (defaultprops) => { const { globalUrl, selectedDoc, serverside, serverMobile } = defaultprops; let navigate = useNavigate(); // Quickfix for react router 5 -> 6 const params = useParams(); //var props = JSON.parse(JSON.stringify(defaultprops)) var props = Object.assign({ selected: false }, defaultprops); props.match = {} props.match.params = params //console.log("PARAMS: ", params) const [mobile, setMobile] = useState(serverMobile === true || isMobile === true ? true : false); const [data, setData] = useState(""); const [firstrequest, setFirstrequest] = useState(true); const [list, setList] = useState([]); const [lastHeading, setLastHeading] = useState(false); const [activeId, setActiveId] = useState() const [isopen, setOpen] = useState(-1); const [hover, setHover] = useState(false); const [, setListLoaded] = useState(false); const [anchorEl, setAnchorEl] = React.useState(null); const [anchorElToc, setAnchorElToc] = React.useState(null); const [headingSet, setHeadingSet] = React.useState(false); const [selectedMeta, setSelectedMeta] = React.useState({ link: "hello", read_time: 2, }); const [tocLines, setTocLines] = React.useState([]); const [baseUrl, setBaseUrl] = React.useState( serverside === true ? "" : window.location.href ); const [hashRendered, setHashRendered] = React.useState(false) const headingElementsRef = useRef({}) useEffect(() => { //if (params["key"] === undefined) { // navigate("/docs/about") // return //} }, []) const handleClick = (event) => { setAnchorEl(event.currentTarget); } const handleClickToc = (event) => { setAnchorElToc(event.currentTarget); } const handleCollapse = (index) => { setOpen(isopen === index ? -1 : index) } const handleMouseOver = () => { setHover(!hover); } const handleClose = () => { setAnchorEl(null) } const handleCloseToc = () => { setAnchorElToc(null) } const intersectionObserver = () => { const callback = (headings) => { headingElementsRef.current = headings.reduce((map, headingElement) => { if (map === undefined) { return {} } if (headingElement === undefined || headingElement.target === undefined || headingElement.target.id === undefined || headingElement.target.id === null || headingElement.target.id === "") { return map } if (headingElement.target.id != undefined || headingElement.target.id != "") { map[headingElement.target.id] = headingElement return map } }, headingElementsRef.current) const visibleHeadings = [] const keys = Object.keys(headingElementsRef.current) for (var i = 0; i < keys.length; i++) { const headingElement = headingElementsRef.current[keys[i]] if (headingElement.isIntersecting) { visibleHeadings.push(headingElement) } } if (visibleHeadings.length > 0) { const tocs = document.getElementsByClassName('toc') for (const t of tocs) { const currentPoint = t.getElementsByTagName('a')[0] currentPoint.style.color = "white"; if (`#${visibleHeadings[0].target.id}` === currentPoint.hash) { currentPoint.style.color = "#f86a3e"; } } } } const observer = new IntersectionObserver(callback, { threshold: [1] }) const headingElements = Array.from(document.querySelectorAll("h2")) if (headingElements.length != 0) { for (var i = 0; i < headingElements.length; i++) { var element = headingElements[i] observer.observe(element) } return () => observer.disconnect() } } if (lastHeading) { setTimeout(() => { intersectionObserver() }, 100) } const scrollToHash = () => { var hash = window.location.hash.replace("#", "").replaceAll("_", "-"); if (hash.includes('?')) { hash = hash.split('?')[0] } if (hash) { console.log("HASH: ", hash) const element = document.getElementById(hash) if (element) { element.scrollIntoView({ behavior: "instant", }) } } } const extractHeadings = content => { const headings = []; const lines = content.split('\n'); let inCodeBlock = false; for (const line of lines) { if (line.startsWith('```')) { inCodeBlock = !inCodeBlock; } if (!inCodeBlock) { const headingMatch = line.match(/^(#{2,3})\s+(.+)$/); if (headingMatch) { const level = headingMatch[1].length; const title = headingMatch[2].trim(); const id = title.toLowerCase().replace(/\s+/g, '-'); if (level === 2) { headings.push({ id, title, items: [] }); } else if (level === 3 && headings.length) { headings[headings.length - 1].items.push({ id, title }); } } } } return headings; }; // extract TOC from actual markdown const tocvalue = (markdown) => { const items = []; let currentMainItem = null; const lines = markdown.split('\n'); for (let i = 0; i < lines.length; i++) { const line = lines[i]; if (line.startsWith('* [') && !line.startsWith(" ", 5)) { const matches = line.match(/^\* \[([^)]+)\]\(#([^)]+)\)/); if (matches) { currentMainItem = { id: matches[2], title: matches[1], items: [], }; items.push(currentMainItem); } } else if (line.startsWith(' * [')) { if (currentMainItem) { const matches = line.match(/^ \* \[([^)]+)\]\(#([^)]+)\)/); if (matches) { currentMainItem.items.push({ id: matches[2], title: matches[1], }); } } } else if (line.startsWith('##')) { continue } } return items } const SidebarPaperStyle = { backgroundColor: "rgb(26,26,26)", backgroundImage: "none", overflowX: "hidden", position: "relative", paddingLeft: 15, paddingRight: 15, minHeight: "80vh", }; const Heading = (props) => { const [hover, setHover] = useState(false); var id = props.children[0].toLowerCase().toString() if (props.level <= 3) { id = props.children[0].toLowerCase().toString().replaceAll(" ", "-"); } const element = React.createElement( `h${props.level}`, { id: `${id}` }, props.children, ) if (serverside !== true && window.location.hash.length > 0 && props.level === 1 && !hashRendered) { setTimeout(() => { setHashRendered(true) scrollToHash() }, 500) } if (serverside !== true && !lastHeading) { setTimeout(() => { setLastHeading(true) }, 500) } var extraInfo = ""; if (props.level === 1) { extraInfo = (
{mobile ? null : ( )} {mobile ? null : (
)} {selectedMeta.read_time} minute {selectedMeta.read_time === 1 ? "" : "s"} to read
{mobile || selectedMeta.contributors === undefined || selectedMeta.contributors === null ? ( "" ) : (
{selectedMeta.contributors.slice(0, 7).map((data, index) => { return ( {data.url} ); })}
)}
); } if (extraInfo !== "" && props.level === 1 && props.children !== undefined && props.children !== null && props.children.length > 0) { if (props.children[0].toLowerCase().includes("privacy") || props.children[0].toLowerCase().includes("terms")) { extraInfo = "" } } return ( { setHover(true); }} id={id} style={{ scrollPaddingTop: 20, }} > {props.level !== 1 ? ( ) : null}
{element}
{extraInfo}
) } const SideBar = { width: "17%", position: "sticky", top: 50, paddingTop: "0.25em", minHeight: "95vh", maxHeight: "95vh", overflowX: "hidden", overflowY: "auto", zIndex: 1000, //borderRight: "1px solid rgba(255,255,255,0.3)", }; const IndexBar = { alignSelf: "flex-start", position: "sticky", top: 80, overflowY: "auto", minHeight: "93vh", maxHeight: "93vh", marginTop: 70, } const fetchDocList = () => { fetch(`${globalUrl}/api/v1/docs`, { method: "GET", headers: { "Content-Type": "application/json", Accept: "application/json", }, }) .then((response) => response.json()) .then((responseJson) => { if (responseJson.success) { setList(responseJson.list); } else { setList(["# Error loading documentation. Please contact us if this persists.",]); toast("Failed loading documentation. Please reload the window") } setListLoaded(true); }) .catch((error) => { }); }; const fetchDocs = (docId) => { fetch(`${globalUrl}/api/v1/docs/${docId}`, { method: "GET", headers: { "Content-Type": "application/json", Accept: "application/json", }, }) .then((response) => response.json()) .then((responseJson) => { if (responseJson.success === false) { //toast("Failed loading documentation. Please reload the UI") } if (responseJson.success && responseJson.reason !== undefined) { // Find tags and translate them into ![]() format const imgRegex = / { }); }; if (firstrequest) { setFirstrequest(false); if (!serverside) { if (window.innerWidth < 768) { setMobile(true); } } if (selectedDoc !== undefined) { setData(selectedDoc.reason); setList(selectedDoc.list); setListLoaded(true); } else { if (!serverside) { fetchDocList(); //const propkey = props.match.params.key //if (propkey === undefined) { // navigate("/docs/about") // return null //} // if (props.match.params.key === undefined) { } else { console.log("DOCID: ", props.match.params.key) fetchDocs(props.match.params.key) } } } } // Handles search-based changes that origin from outside this file if (serverside !== true && window.location.href !== baseUrl) { setBaseUrl(window.location.href); fetchDocs(props.match.params.key); } // const parseElementScroll = () => { // const offset = 45; // var parent = document.getElementById("markdown_wrapper_outer"); // if (parent !== null) { // //console.log("IN PARENT") // var elements = parent.getElementsByTagName("h2"); // // const name = window.location.hash // .slice(1, window.location.hash.length) // .toLowerCase() // .split("%20") // .join(" ") // .split("_") // .join(" ") // .split("-") // .join(" ") // .split("?")[0] // // //console.log(name) // var found = false; // for (var key in elements) { // const element = elements[key]; // if (element.innerHTML === undefined) { // continue; // } // // // Fix location.. // if (element.innerHTML.toLowerCase() === name) { // //console.log(element.offsetTop) // element.scrollIntoView({ behavior: "smooth" }); // //element.scrollTo({ // // top: element.offsetTop+offset, // // behavior: "smooth" // //}) // found = true; // //element.scrollTo({ // // top: element.offsetTop-100, // // behavior: "smooth" // //}) // } // } // // // H# // if (!found) { // elements = parent.getElementsByTagName("h3"); // //console.log("NAMe: ", name) // found = false; // for (key in elements) { // const element = elements[key]; // if (element.innerHTML === undefined) { // continue; // } // // // Fix location.. // if (element.innerHTML.toLowerCase() === name) { // element.scrollIntoView({ behavior: "smooth" }); // //element.scrollTo({ // // top: element.offsetTop-offset, // // behavior: "smooth" // //}) // found = true; // //element.scrollTo({ // // top: element.offsetTop-100, // // behavior: "smooth" // //}) // } // } // } // } // //console.log(element) // // //console.log("NAME: ", name) // //console.log(document.body.innerHTML) // // parent = document.getElementById(parent); // // //var descendants = parent.getElementsByTagName(tagname); // // // this.scrollDiv.current.scrollIntoView({ behavior: 'smooth' }); // // //$(".parent").find("h2:contains('Statistics')").parent(); // }; const markdownStyle = { color: "rgba(255, 255, 255, 0.90)", overflow: "hidden", paddingBottom: 100, margin: "auto", maxWidth: "100%", minWidth: "100%", overflow: "hidden", fontSize: isMobile ? "1.3rem" : "1.1rem", }; const CustomButton = (props) => { const { title, icon, link } = props return (
{ if (link === "" || link === undefined) { event.preventDefault() console.log("IN CLICK!") if (window.drift !== undefined) { window.drift.api.startInteraction({ interactionId: 340043 }) } else { console.log("Couldn't find drift in window.drift and not .drift-open-chat with querySelector: ", window.drift) } } else { console.log("Link defined: ", link) } }} onMouseOver={() => { setHover(true) }} onMouseOut={() => { setHover(false); }} > {icon} {title}
) } const DocumentationButton = (props) => { const { item, link } = props if (link === undefined || link === null) { return null } return (
{ setHover(true) }} onMouseOut={() => { setHover(false); }} > {item}
) } const headerStyle = { marginTop: 25, } const mainpageInfo =
Documentation
/> link="https://discord.gg/B2CBzUm" />
Tutorial Dive in. Hands-on is the best approach to see how Shuffle can transform your security operations. Our set of tutorials and videos teach you how to build your skills. Check out the getting started section to give it a go! Why Shuffle? Security first. We incentivize trying before buying, and give you the full set of tools you need to automate your operations. What's more is we also help you find usecases that fit your unique needs. Accessibility is key, and we intend to help every SOC globally use and share their usecases. Get help Our promise is to make it easier and easier to automate your operations. In some cases however, it may be good with a helping hand. That's where Shuffle's consultancy and support services come in handy. We help you build and automate your operational processes to a level you haven't seen before with the help of our usecases. APIs Learn. We're all about learning, and are continuously creating documentation and video tutorials to better understand how to get started. APIs are an extremely important part of how the internet works today, and our goal is helping every security professional learn about them. Workflow building Build. Creating workflows has never been easier. Jump into things with our getting Started section and build to your hearts content. Workflows make it all come together, with an easy to use area. Managing Shuffle Organize. Whether an organization of 1000 or 1, management tools are necessary. In Shuffle we offer full user management, MFA and single-signon options, multi-tenancy and a lot more - for free!
const markdownComponents = { img: Img, code: CodeHandler, h1: Heading, h2: Heading, h3: Heading, h4: Heading, h5: Heading, h6: Heading, a: OuterLink, p: Paragrah, } // PostDataBrowser Section const postDataBrowser = list === undefined || list === null ? null : (
{list.map((data, index) => { const item = data.name; if (item === undefined) { return null; } const path = "/docs/" + item; const newname = item.charAt(0).toUpperCase() + item.substring(1).split("_").join(" ").split("-").join(" "); const itemMatching = props.match.params.key === undefined ? false : props.match.params.key.toLowerCase() === item.toLowerCase(); return (
  • {newname}
  • ); })}
    {props.match.params.key === undefined ? mainpageInfo :
    {data}
    }
    {tocLines.length > 0 ? (

    Table Of Content

    ) : null}
    ); const mobileStyle = { color: "white", marginLeft: 25, marginRight: 25, paddingBottom: 50, backgroundColor: "inherit", display: "flex", flexDirection: "column", }; const postDataMobile = list === undefined || list === null ? null : (
    {list.map((data, index) => { const item = data.name; if (item === undefined) { return null; } const path = "/docs/" + item; const newname = item.charAt(0).toUpperCase() + item.substring(1).split("_").join(" ").split("-").join(" "); return ( { window.location.pathname = path; }} > {newname} ); })} {tocLines.map((data, index) => { return ( {data.title} ) })}
    {props.match.params.key === undefined ? mainpageInfo :
    {data}
    }
    ); // Padding and zIndex etc set because of footer in cloud. const loadedCheck = (
    {postDataBrowser} {postDataMobile}
    ); return
    {loadedCheck}
    ; }; export default Docs;