@automattic/jetpack-scan 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2024-11-25
+### Added
+- Adds utilities for retrieving fixer messaging [#40197]
+
+### Changed
+- Updated package dependencies. [#40288]
+
+## [0.2.0] - 2024-11-14
+### Added
+- Adds fixer utility functions [#40111]
+
 ## 0.1.0 - 2024-11-11
 ### Added
 - Added threat and fixer types. [#39754]
@@ -52,3 +63,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 - Updated dependencies. [#39754]
+
+[0.3.0]: https://github.com/Automattic/jetpack-scan/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/Automattic/jetpack-scan/compare/v0.1.0...v0.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
 	"private": false,
 	"name": "@automattic/jetpack-scan",
-	"version": "0.1.0",
+	"version": "0.3.0",
 	"description": "A JS client for consuming Jetpack Scan services",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/scan/#readme",
 	"bugs": {
@@ -34,7 +34,7 @@
 		"@testing-library/react": "16.0.1",
 		"@types/jest": "29.5.12",
 		"@types/react": "18.3.12",
-		"@wordpress/babel-plugin-import-jsx-pragma": "5.11.0",
+		"@wordpress/babel-plugin-import-jsx-pragma": "5.12.0",
 		"babel-jest": "29.7.0",
 		"jest": "^29.7.0",
 		"jest-environment-jsdom": "29.7.0",
@@ -50,18 +50,18 @@
 	"main": "./build/index.js",
 	"types": "./build/index.d.ts",
 	"dependencies": {
-		"@automattic/jetpack-api": "^0.17.17",
-		"@automattic/jetpack-base-styles": "^0.6.35",
-		"@wordpress/api-fetch": "7.11.0",
-		"@wordpress/element": "6.11.0",
-		"@wordpress/i18n": "5.11.0",
-		"@wordpress/url": "4.11.0",
+		"@automattic/jetpack-api": "^0.17.19",
+		"@automattic/jetpack-base-styles": "^0.6.37",
+		"@wordpress/api-fetch": "7.12.0",
+		"@wordpress/element": "6.12.0",
+		"@wordpress/i18n": "5.12.0",
+		"@wordpress/url": "4.12.0",
 		"debug": "4.3.4",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
 	"peerDependencies": {
-		"@wordpress/i18n": "5.11.0",
+		"@wordpress/i18n": "5.12.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	}

package/src/utils/index.ts

@@ -1,3 +1,4 @@
+import { __, sprintf } from '@wordpress/i18n';
 import { Threat, ThreatFixStatus, FIXER_IS_STALE_THRESHOLD } from '..';
 
 export const getThreatType = ( threat: Threat ) => {
@@ -20,10 +21,99 @@ export const fixerTimestampIsStale = ( lastUpdatedTimestamp: string ) => {
 	return now.getTime() - lastUpdated.getTime() >= FIXER_IS_STALE_THRESHOLD;
 };
 
-export const fixerStatusIsStale = ( fixerStatus: ThreatFixStatus ) => {
+export const fixerIsInError = ( fixerStatus: ThreatFixStatus ): boolean => {
+	return !! ( 'error' in fixerStatus && fixerStatus.error );
+};
+
+export const fixerIsInProgress = ( fixerStatus: ThreatFixStatus ): boolean => {
+	return !! ( 'status' in fixerStatus && fixerStatus.status === 'in_progress' );
+};
+
+export const fixerStatusIsStale = ( fixerStatus: ThreatFixStatus ): boolean => {
 	return (
-		'status' in fixerStatus &&
-		fixerStatus.status === 'in_progress' &&
-		fixerTimestampIsStale( fixerStatus.lastUpdated )
+		fixerIsInProgress( fixerStatus ) &&
+		'lastUpdated' in fixerStatus &&
+		!! fixerTimestampIsStale( fixerStatus.lastUpdated )
 	);
 };
+
+export const getFixerState = ( fixerStatus: ThreatFixStatus ) => {
+	return {
+		inProgress: fixerStatus && fixerIsInProgress( fixerStatus ),
+		error: fixerStatus && fixerIsInError( fixerStatus ),
+		stale: fixerStatus && fixerStatusIsStale( fixerStatus ),
+	};
+};
+
+export const getFixerAction = ( threat: Threat ) => {
+	switch ( threat.fixable && threat.fixable.fixer ) {
+		case 'delete':
+			return __( 'Delete', 'jetpack-scan' );
+		case 'update':
+			return __( 'Update', 'jetpack-scan' );
+		case 'replace':
+		case 'rollback':
+			return __( 'Replace', 'jetpack-scan' );
+		default:
+			return __( 'Fix', 'jetpack-scan' );
+	}
+};
+
+export const getFixerMessage = ( threat: Threat ) => {
+	switch ( threat.fixable && threat.fixable.fixer ) {
+		case 'delete':
+			if ( threat.filename ) {
+				if ( threat.filename.endsWith( '/' ) ) {
+					return __( 'Deletes the directory that the infected file is in.', 'jetpack-scan' );
+				}
+
+				if ( threat.signature === 'Core.File.Modification' ) {
+					return __( 'Deletes the unexpected file in a core WordPress directory.', 'jetpack-scan' );
+				}
+
+				return __( 'Deletes the infected file.', 'jetpack-scan' );
+			}
+
+			if ( threat.extension?.type === 'plugin' ) {
+				return __( 'Deletes the plugin directory to fix the threat.', 'jetpack-scan' );
+			}
+
+			if ( threat.extension?.type === 'theme' ) {
+				return __( 'Deletes the theme directory to fix the threat.', 'jetpack-scan' );
+			}
+			break;
+		case 'update':
+			if ( threat.fixedIn && threat.extension.name ) {
+				return sprintf(
+					/* translators: Translates to Updates to version. %1$s: Name. %2$s: Fixed version */
+					__( 'Updates %1$s to version %2$s', 'jetpack-scan' ),
+					threat.extension.name,
+					threat.fixedIn
+				);
+			}
+			return __( 'Upgrades the plugin or theme to a newer version.', 'jetpack-scan' );
+		case 'replace':
+		case 'rollback':
+			if ( threat.filename ) {
+				return threat.signature === 'Core.File.Modification'
+					? __(
+							'Replaces the modified core WordPress file with the original clean version from the WordPress source code.',
+							'jetpack-scan'
+					  )
+					: __(
+							'Replaces the infected file with a previously backed up version that is clean.',
+							'jetpack-scan'
+					  );
+			}
+
+			if ( threat.signature === 'php_hardening_WP_Config_NoSalts_001' ) {
+				return __(
+					'Replaces the default salt keys in wp-config.php with unique ones.',
+					'jetpack-scan'
+				);
+			}
+			break;
+		default:
+			return __( 'Jetpack will auto-fix the threat.', 'jetpack-scan' );
+	}
+};