@automattic/jetpack-components 0.58.0 → 0.59.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ### This is a list detailing changes for the Jetpack RNA Components package releases.
 
+## [0.59.0] - 2024-11-11
+### Added
+- Add ThreatsDataViews component [#39754]
+- Components: add ref for container component [#39850]
+- IconTooltip: add support for showing tooltip on hover. [#39916]
+
+### Changed
+- Add ToggleGroupControl to ThreatsDataViews for easily toggling between Active and Historical threats [#39901]
+- Updated package dependencies. [#39999]
+- Updated package dependencies. [#40000]
+- Updated package dependencies. [#40060]
+
+## [0.58.1] - 2024-11-04
+### Added
+- Enable test coverage. [#39961]
+
+### Fixed
+- Fix tooltip behavior. [#39879]
+
 ## [0.58.0] - 2024-10-15
 ### Added
 - Add DiffViewer component [#39672]
@@ -1195,6 +1214,8 @@
 ### Changed
 - Update node version requirement to 14.16.1
 
+[0.59.0]: https://github.com/Automattic/jetpack-components/compare/0.58.1...0.59.0
+[0.58.1]: https://github.com/Automattic/jetpack-components/compare/0.58.0...0.58.1
 [0.58.0]: https://github.com/Automattic/jetpack-components/compare/0.57.0...0.58.0
 [0.57.0]: https://github.com/Automattic/jetpack-components/compare/0.56.3...0.57.0
 [0.56.3]: https://github.com/Automattic/jetpack-components/compare/0.56.2...0.56.3

package/components/badge/index.tsx

@@ -0,0 +1,39 @@
+import clsx from 'clsx';
+import React from 'react';
+import styles from './style.module.scss';
+
+type BadgeProps = {
+	children?: React.ReactNode;
+	className?: string;
+	variant?: 'success' | 'warning' | 'danger';
+	[ key: string ]: unknown;
+};
+
+/**
+ * Badge component
+ *
+ * @param {object}      props           - The component properties.
+ * @param {string}      props.variant   - The badge variant (i.e. 'success', 'warning', 'danger').
+ * @param {JSX.Element} props.children  - Badge text or content.
+ * @param {string}      props.className - Additional class name to pass to the Badge component.
+ *
+ * @return {React.ReactElement} The `Badge` component.
+ */
+const Badge: React.FC< BadgeProps > = ( { children, className, variant = 'info', ...props } ) => {
+	const classes = clsx(
+		styles.badge,
+		{
+			[ styles[ 'is-success' ] ]: variant === 'success',
+			[ styles[ 'is-warning' ] ]: variant === 'warning',
+			[ styles[ 'is-danger' ] ]: variant === 'danger',
+		},
+		className
+	);
+	return (
+		<span className={ classes } { ...props }>
+			{ children }
+		</span>
+	);
+};
+
+export default Badge;

package/components/badge/style.module.scss

@@ -0,0 +1,25 @@
+.badge {
+	display: inline-block;
+	border-radius: 4px;
+	background-color: var(--jp-gray-0);
+	color: var(--jp-gray-80);
+	padding: 4px 8px;
+	font-size: 13px;
+	font-weight: 400;
+	line-height: 16px;
+
+	&.is-success {
+		background-color: var(--jp-green-5);
+		color: var(--jp-green-50);
+	}
+
+    &.is-warning {
+		background-color: var(--jp-yellow-5);
+		color: var(--jp-yellow-60);
+	}
+
+    &.is-danger {
+		background-color: var(--jp-red-5);
+		color: var(--jp-red-70);
+	}
+}

package/components/boost-score-graph/style-tooltip.scss

@@ -5,6 +5,17 @@ $white: #ffffff;
 .jb-score-tooltips-container {
     width: 100%;
     position: relative;
+    pointer-events: none;
+
+}
+
+.jb-score-tooltip-react-root {
+    position: absolute;
+    bottom: -20px;
+    translate: -50% calc( 100% - 20px );
+    z-index: 1000;
+    pointer-events: auto;
+    user-select: text;
 }
 
 .jb-score-tooltip {
@@ -17,6 +28,11 @@ $white: #ffffff;
     width: 20em;
     position: relative;
     box-shadow: 0px 1px 2px 0px rgba(0, 0, 0, 0.05);
+    display: none;
+
+    .visible &, &:hover {
+        display: block;
+    }
 
     hr {
         border-top: 1px solid $grey;

package/components/boost-score-graph/tooltips-plugin.ts

@@ -25,35 +25,26 @@ export function tooltipsPlugin( periods ) {
 		if ( ! reactDom ) {
 			reactDom = ReactDOM.createRoot( reactRoot );
 		}
-		reactRoot.style.position = 'absolute';
-		reactRoot.style.bottom = -20 + 'px';
-		reactRoot.style.translate = '-50% calc( 100% - 20px )';
-		reactRoot.style.zIndex = '1000';
+		reactRoot.classList.add( 'jb-score-tooltip-react-root' );
 
 		container.appendChild( reactRoot );
 
 		u.over.appendChild( container );
 
-		/**
-		 * Hides all tooltips.
-		 */
-		function hideTips() {
-			reactRoot.style.display = 'none';
-		}
+		u.over.addEventListener( 'mouseenter', () => {
+			container.classList.add( 'visible' );
+		} );
 
-		/**
-		 * Shows all tooltips.
-		 */
-		function showTips() {
-			reactRoot.style.display = null;
-		}
+		u.over.addEventListener( 'mouseleave', () => {
+			container.classList.remove( 'visible' );
+		} );
 
-		container.addEventListener( 'mouseleave', () => {
-			hideTips();
+		reactRoot.addEventListener( 'mouseenter', () => {
+			reactRoot.classList.add( 'visible' );
 		} );
 
-		container.addEventListener( 'mouseenter', () => {
-			showTips();
+		reactRoot.addEventListener( 'mouseleave', () => {
+			reactRoot.classList.remove( 'visible' );
 		} );
 	}
 
@@ -62,7 +53,7 @@ export function tooltipsPlugin( periods ) {
 	 * @param {uPlot} u - The uPlot instance.
 	 */
 	function setSize( u: uPlot ) {
-		container.style.height = u.over.clientHeight + 'px';
+		container.style.paddingTop = u.over.clientHeight + 'px';
 	}
 
 	/**
@@ -75,6 +66,10 @@ export function tooltipsPlugin( periods ) {
 
 		const period = periods[ idx ];
 
+		if ( ! period ) {
+			return;
+		}
+
 		// Timestamp of the cursor position
 		const timestamp = u.data[ 0 ][ idx ];
 

package/components/icon-tooltip/index.tsx

@@ -38,12 +38,14 @@ const IconTooltip: React.FC< IconTooltipProps > = ( {
 	children,
 	popoverAnchorStyle = 'icon',
 	forceShow = false,
+	hoverShow = false,
 	wide = false,
 	inline = true,
 	shift = false,
 } ) => {
 	const POPOVER_HELPER_WIDTH = 124;
 	const [ isVisible, setIsVisible ] = useState( false );
+	const [ hoverTimeout, setHoverTimeout ] = useState( null );
 	const hideTooltip = useCallback( () => setIsVisible( false ), [ setIsVisible ] );
 	const toggleTooltip = useCallback(
 		e => {
@@ -78,8 +80,33 @@ const IconTooltip: React.FC< IconTooltipProps > = ( {
 
 	const isForcedToShow = isAnchorWrapper && forceShow;
 
+	const handleMouseEnter = useCallback( () => {
+		if ( hoverShow ) {
+			if ( hoverTimeout ) {
+				clearTimeout( hoverTimeout );
+				setHoverTimeout( null );
+			}
+			setIsVisible( true );
+		}
+	}, [ hoverShow, hoverTimeout ] );
+
+	const handleMouseLeave = useCallback( () => {
+		if ( hoverShow ) {
+			const id = setTimeout( () => {
+				setIsVisible( false );
+				setHoverTimeout( null );
+			}, 100 );
+			setHoverTimeout( id );
+		}
+	}, [ hoverShow ] );
+
 	return (
-		<div className={ wrapperClassNames } data-testid="icon-tooltip_wrapper">
+		<div
+			className={ wrapperClassNames }
+			data-testid="icon-tooltip_wrapper"
+			onMouseEnter={ handleMouseEnter }
+			onMouseLeave={ handleMouseLeave }
+		>
 			{ ! isAnchorWrapper && (
 				<Button variant="link" onMouseDown={ toggleTooltip }>
 					<Gridicon className={ iconClassName } icon={ iconCode } size={ iconSize } />

package/components/icon-tooltip/types.ts

@@ -69,6 +69,11 @@ export type IconTooltipProps = {
 	 */
 	forceShow?: boolean;
 
+	/**
+	 * Enables the Popover to show on hover.
+	 */
+	hoverShow?: boolean;
+
 	/**
 	 * Uses a wider content area when enabled.
 	 */

package/components/layout/container/index.tsx

@@ -1,5 +1,5 @@
 import clsx from 'clsx';
-import { createElement, useMemo } from 'react';
+import { createElement, forwardRef, useMemo } from 'react';
 import { ContainerProps } from '../types';
 import styles from './style.module.scss';
 import type React from 'react';
@@ -7,17 +7,21 @@ import type React from 'react';
 /**
  * JP Container
  *
- * @param {ContainerProps} props - Component properties.
+ * @param {ContainerProps}         props - Component properties.
+ * @param {React.MutableRefObject} ref   - Ref to the component
  * @return {React.ReactElement}   Container component.
  */
-const Container: React.FC< ContainerProps > = ( {
-	children,
-	fluid = false,
-	tagName = 'div',
-	className,
-	horizontalGap = 1,
-	horizontalSpacing = 1,
-} ) => {
+const Container = (
+	{
+		children,
+		fluid = false,
+		tagName = 'div',
+		className,
+		horizontalGap = 1,
+		horizontalSpacing = 1,
+	}: ContainerProps,
+	ref: React.MutableRefObject< HTMLElement | null >
+): React.ReactElement => {
 	const containerStyle = useMemo( () => {
 		const padding = `calc( var(--horizontal-spacing) * ${ horizontalSpacing } )`;
 		const rowGap = `calc( var(--horizontal-spacing) * ${ horizontalGap } )`;
@@ -38,9 +42,10 @@ const Container: React.FC< ContainerProps > = ( {
 		{
 			className: containerClassName,
 			style: containerStyle,
+			ref,
 		},
 		children
 	);
 };
 
-export default Container;
+export default forwardRef< HTMLElement, ContainerProps >( Container );

package/components/text/index.tsx

@@ -1,5 +1,5 @@
 import clsx from 'clsx';
-import React, { useMemo, forwardRef } from 'react';
+import React, { forwardRef, useMemo } from 'react';
 import { BOX_MODEL_VALUES, VARIANTS_MAPPING } from './constants';
 import styles from './style.module.scss';
 import type { H3Props, TextProps, TitleProps } from './types';
@@ -26,12 +26,11 @@ const Text = forwardRef< HTMLElement, TextProps >(
 			}, '' );
 		}, [ componentProps ] );
 
-		componentProps.ref = ref;
-
 		return (
 			<Component
 				className={ clsx( styles.reset, styles[ variant ], className, boxModelClasses ) }
 				{ ...componentProps }
+				ref={ ref }
 			>
 				{ children }
 			</Component>

package/components/text/types.ts

@@ -39,7 +39,6 @@ export type TextProps = {
 	children: React.ReactNode;
 	/** Force an specific tag (span, div) or use a custom component that will receive className and children */
 	component?: React.FC< { [ prop: string ]: unknown } > | React.ElementType;
-	[ prop: string ]: unknown;
 };
 
 export type H3Props = TextProps & {

package/components/threat-fixer-button/index.tsx

@@ -0,0 +1,142 @@
+import { Button, Text, ActionPopover } from '@automattic/jetpack-components';
+import { CONTACT_SUPPORT_URL, type Threat, fixerStatusIsStale } from '@automattic/jetpack-scan';
+import { ExternalLink } from '@wordpress/components';
+import { createInterpolateElement, useCallback, useMemo, useState } from '@wordpress/element';
+import { __, sprintf } from '@wordpress/i18n';
+import styles from './styles.module.scss';
+
+/**
+ * Threat Fixer Button component.
+ *
+ * @param {object}   props           - Component props.
+ * @param {object}   props.threat    - The threat.
+ * @param {Function} props.onClick   - The onClick function.
+ * @param {string}   props.className - The className.
+ *
+ * @return {JSX.Element} The component.
+ */
+export default function ThreatFixerButton( {
+	threat,
+	className,
+	onClick,
+}: {
+	threat: Threat;
+	onClick: ( items: Threat[] ) => void;
+	className?: string;
+} ): JSX.Element {
+	const [ isPopoverVisible, setIsPopoverVisible ] = useState( false );
+
+	const [ anchor, setAnchor ] = useState( null );
+
+	const children = useMemo( () => {
+		if ( ! threat.fixable ) {
+			return null;
+		}
+		if ( threat.fixer && 'error' in threat.fixer && threat.fixer.error ) {
+			return __( 'Error', 'jetpack' );
+		}
+		if ( threat.fixer && 'status' in threat.fixer && threat.fixer.status === 'in_progress' ) {
+			return __( 'Fixing…', 'jetpack' );
+		}
+		if ( threat.fixable.fixer === 'delete' ) {
+			return __( 'Delete', 'jetpack' );
+		}
+		if ( threat.fixable.fixer === 'update' ) {
+			return __( 'Update', 'jetpack' );
+		}
+		return __( 'Fix', 'jetpack' );
+	}, [ threat.fixable, threat.fixer ] );
+
+	const errorMessage = useMemo( () => {
+		if ( threat.fixer && fixerStatusIsStale( threat.fixer ) ) {
+			return __( 'The fixer is taking longer than expected.', 'jetpack' );
+		}
+
+		if ( threat.fixer && 'error' in threat.fixer && threat.fixer.error ) {
+			return __( 'An error occurred auto-fixing this threat.', 'jetpack' );
+		}
+
+		return null;
+	}, [ threat.fixer ] );
+
+	const handleClick = useCallback(
+		( event: React.MouseEvent ) => {
+			event.stopPropagation();
+			if ( errorMessage && ! isPopoverVisible ) {
+				setIsPopoverVisible( true );
+				return;
+			}
+			onClick( [ threat ] );
+		},
+		[ onClick, errorMessage, isPopoverVisible, threat ]
+	);
+
+	const closePopover = useCallback( () => {
+		setIsPopoverVisible( false );
+	}, [] );
+
+	if ( ! threat.fixable ) {
+		return null;
+	}
+
+	return (
+		<div>
+			<Button
+				size="small"
+				weight="regular"
+				variant="secondary"
+				onClick={ handleClick }
+				children={ children }
+				className={ className }
+				disabled={
+					threat.fixer &&
+					'status' in threat.fixer &&
+					threat.fixer.status === 'in_progress' &&
+					! errorMessage
+				}
+				isLoading={
+					threat.fixer && 'status' in threat.fixer && threat.fixer.status === 'in_progress'
+				}
+				isDestructive={
+					( threat.fixable && threat.fixable.fixer === 'delete' ) ||
+					( threat.fixer && 'error' in threat.fixer && threat.fixer.error ) ||
+					( threat.fixer && fixerStatusIsStale( threat.fixer ) )
+				}
+				style={ { minWidth: '72px' } }
+				ref={ setAnchor }
+			/>
+			{ isPopoverVisible && (
+				<ActionPopover
+					anchor={ anchor }
+					buttonContent={ __( 'Retry Fix', 'jetpack' ) }
+					hideCloseButton={ true }
+					noArrow={ false }
+					onClick={ handleClick }
+					onClose={ closePopover }
+					title={ __( 'Auto-fix error', 'jetpack' ) }
+				>
+					<Text>
+						{ createInterpolateElement(
+							sprintf(
+								/* translators: placeholder is an error message.  */
+								__(
+									'%s Please try again or <supportLink>contact support</supportLink>.',
+									'jetpack'
+								),
+								errorMessage
+							),
+							{
+								supportLink: (
+									<ExternalLink
+										href={ CONTACT_SUPPORT_URL }
+										className={ styles[ 'support-link' ] }
+									/>
+								),
+							}
+						) }
+					</Text>
+				</ActionPopover>
+			) }
+		</div>
+	);
+}

package/components/threat-fixer-button/styles.module.scss

@@ -0,0 +1,9 @@
+.support-link {
+	color: inherit;
+
+	&:focus,
+	&:hover {
+		color: inherit;
+		box-shadow: none;
+	}
+}

package/components/threat-severity-badge/index.tsx

@@ -1,34 +1,24 @@
 import { _x } from '@wordpress/i18n';
-import styles from './styles.module.scss';
+import Badge from '../badge';
 
-const severityClassNames = severity => {
+const ThreatSeverityBadge = ( { severity } ) => {
 	if ( severity >= 5 ) {
-		return 'is-critical';
-	} else if ( severity >= 3 && severity < 5 ) {
-		return 'is-high';
+		return (
+			<Badge variant="danger">
+				{ _x( 'Critical', 'Severity label for issues rated 5 or higher.', 'jetpack' ) }
+			</Badge>
+		);
 	}
-	return 'is-low';
-};
 
-const severityText = severity => {
-	if ( severity >= 5 ) {
-		return _x( 'Critical', 'Severity label for issues rated 5 or higher.', 'jetpack' );
-	} else if ( severity >= 3 && severity < 5 ) {
-		return _x( 'High', 'Severity label for issues rated between 3 and 5.', 'jetpack' );
+	if ( severity >= 3 && severity < 5 ) {
+		return (
+			<Badge variant="warning">
+				{ _x( 'High', 'Severity label for issues rated between 3 and 5.', 'jetpack' ) }
+			</Badge>
+		);
 	}
-	return _x( 'Low', 'Severity label for issues rated below 3.', 'jetpack' );
-};
 
-const ThreatSeverityBadge = ( { severity } ) => {
-	return (
-		<div
-			className={ `${ styles[ 'threat-severity-badge' ] } ${
-				styles[ severityClassNames( severity ) ]
-			}` }
-		>
-			{ severityText( severity ) }
-		</div>
-	);
+	return <Badge>{ _x( 'Low', 'Severity label for issues rated below 3.', 'jetpack' ) }</Badge>;
 };
 
 export default ThreatSeverityBadge;

package/components/threats-data-views/constants.ts

@@ -0,0 +1,49 @@
+import { __ } from '@wordpress/i18n';
+import {
+	code as fileIcon,
+	color as themeIcon,
+	plugins as pluginIcon,
+	shield as shieldIcon,
+	wordpress as coreIcon,
+} from '@wordpress/icons';
+
+export const THREAT_STATUSES: { value: string; label: string; variant?: 'success' | 'warning' }[] =
+	[
+		{ value: 'current', label: __( 'Active', 'jetpack' ), variant: 'warning' },
+		{ value: 'fixed', label: __( 'Fixed', 'jetpack' ), variant: 'success' },
+		{ value: 'ignored', label: __( 'Ignored', 'jetpack' ) },
+	];
+
+export const THREAT_TYPES = [
+	{ value: 'plugin', label: __( 'Plugin', 'jetpack' ) },
+	{ value: 'theme', label: __( 'Theme', 'jetpack' ) },
+	{ value: 'core', label: __( 'WordPress', 'jetpack' ) },
+	{ value: 'file', label: __( 'File', 'jetpack' ) },
+];
+
+export const THREAT_ICONS = {
+	plugin: pluginIcon,
+	theme: themeIcon,
+	core: coreIcon,
+	file: fileIcon,
+	default: shieldIcon,
+};
+
+export const THREAT_FIELD_THREAT = 'threat';
+export const THREAT_FIELD_TITLE = 'title';
+export const THREAT_FIELD_DESCRIPTION = 'description';
+export const THREAT_FIELD_ICON = 'icon';
+export const THREAT_FIELD_STATUS = 'status';
+export const THREAT_FIELD_TYPE = 'type';
+export const THREAT_FIELD_EXTENSION = 'extension';
+export const THREAT_FIELD_PLUGIN = 'plugin';
+export const THREAT_FIELD_THEME = 'theme';
+export const THREAT_FIELD_SEVERITY = 'severity';
+export const THREAT_FIELD_SIGNATURE = 'signature';
+export const THREAT_FIELD_FIRST_DETECTED = 'first-detected';
+export const THREAT_FIELD_FIXED_ON = 'fixed-on';
+export const THREAT_FIELD_AUTO_FIX = 'auto-fix';
+
+export const THREAT_ACTION_FIX = 'fix';
+export const THREAT_ACTION_IGNORE = 'ignore';
+export const THREAT_ACTION_UNIGNORE = 'unignore';