@automattic/jetpack-scan 0.4.0 → 0.5.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.5.0] - 2024-12-04
+### Added
+- Added more types for working with scan results. [#40399]
+
+### Changed
+- Updated package dependencies. [#40363]
+
+## [0.4.1] - 2024-11-28
+### Fixed
+- Fix package build. [#40299]
+
 ## [0.4.0] - 2024-11-26
 ### Added
 - Adds utility for retrieving a detailed action description [#40214]
@@ -68,6 +79,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 - Updated dependencies. [#39754]
 
+[0.5.0]: https://github.com/Automattic/jetpack-scan/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/Automattic/jetpack-scan/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/Automattic/jetpack-scan/compare/v0.3.0...v0.4.0
 [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/build/constants/index.d.ts

@@ -0,0 +1,3 @@
+export declare const CONTACT_SUPPORT_URL = "https://jetpack.com/contact-support/?rel=support";
+/** Once a fixer has been running for this specified amount of time (in ms), it should be considered "stale". */
+export declare const FIXER_IS_STALE_THRESHOLD: number;

package/build/constants/index.js

@@ -0,0 +1,3 @@
+export const CONTACT_SUPPORT_URL = 'https://jetpack.com/contact-support/?rel=support';
+/** Once a fixer has been running for this specified amount of time (in ms), it should be considered "stale". */
+export const FIXER_IS_STALE_THRESHOLD = 1000 * 60 * 60 * 24; // 24 hours

package/build/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types/index.js';
+export * from './constants/index.js';
+export * from './utils/index.js';

package/build/index.js

@@ -0,0 +1,3 @@
+export * from './types/index.js';
+export * from './constants/index.js';
+export * from './utils/index.js';

package/build/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/index.test.js

@@ -0,0 +1,4 @@
+test('Scan Package', () => {
+    expect(true).toBe(true);
+});
+export {};

package/build/types/fixers.d.ts

@@ -0,0 +1,34 @@
+export type FixerStatus = 'not_started' | 'in_progress' | 'fixed' | 'not_fixed';
+/**
+ * Threat Fix Status
+ *
+ * Individual fixer status for a threat.
+ */
+export type ThreatFixStatusError = {
+    error: string;
+};
+export type ThreatFixStatusSuccess = {
+    status: FixerStatus;
+    lastUpdated: string;
+};
+export type ThreatFixStatus = ThreatFixStatusError | ThreatFixStatusSuccess;
+/**
+ * Fixers Status
+ *
+ * Overall status of all fixers.
+ */
+type FixersStatusBase = {
+    ok: boolean;
+};
+export type FixersStatusError = FixersStatusBase & {
+    ok: false;
+    error: string;
+};
+export type FixersStatusSuccess = FixersStatusBase & {
+    ok: true;
+    threats: {
+        [key: number]: ThreatFixStatus;
+    };
+};
+export type FixersStatus = FixersStatusSuccess | FixersStatusError;
+export {};

package/build/types/fixers.js

@@ -0,0 +1 @@
+export {};

package/build/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './fixers.js';
+export * from './status.js';
+export * from './threats.js';

package/build/types/index.js

@@ -0,0 +1,3 @@
+export * from './fixers.js';
+export * from './status.js';
+export * from './threats.js';

package/build/types/status.d.ts

@@ -0,0 +1,23 @@
+import { Threat } from './threats.js';
+export type ScanStatus = {
+    /** The current status of the scanner. */
+    status: 'unavailable' | 'provisioning' | 'idle' | 'scanning' | 'scheduled';
+    /** The IDs of fixable threats. */
+    fixableThreatIds: number[];
+    /** The current scan progress, only available from the Scan API. */
+    currentProgress: number | null;
+    /** The data source for the scan status. */
+    dataSource: 'protect_report' | 'scan_api';
+    /** Whether the site currently has extensions not checked in the latest scan. */
+    hasUncheckedItems: boolean;
+    /** The time the last scan was checked, in YYYY-MM-DD HH:MM:SS format. */
+    lastChecked: string | null;
+    /** Whether there was an error in the scan results. */
+    error: boolean | null;
+    /** The error code. */
+    errorCode: string | null;
+    /** The error message. */
+    errorMessage: string | null;
+    /** The detected threats. */
+    threats: Threat[];
+};

package/build/types/status.js

@@ -0,0 +1 @@
+export {};

package/build/types/threats.d.ts

@@ -0,0 +1,46 @@
+import { ThreatFixStatus } from './fixers.js';
+export type ThreatStatus = 'fixed' | 'ignored' | 'current';
+export type ThreatFixType = 'replace' | 'delete' | 'update' | string;
+export type Threat = {
+    /** The threat's unique ID. */
+    id: string | number;
+    /** The threat's title. */
+    title?: string;
+    /** The threat's description. */
+    description?: string;
+    /** The threat's current status. */
+    status?: ThreatStatus;
+    /** The threat's severity level (0-10). */
+    severity?: number;
+    /** The threat's signature. */
+    signature?: string;
+    /** The date the threat was first detected on the site, in YYYY-MM-DDTHH:MM:SS.000Z format. */
+    firstDetected?: string;
+    /** The version the threat is fixed in. */
+    fixedIn?: string | null;
+    /** The date the threat was fixed, in YYYY-MM-DDTHH:MM:SS.000Z format. */
+    fixedOn?: string;
+    /** The fixable details. */
+    fixable?: {
+        fixer: ThreatFixType;
+        target?: string | null;
+        extensionStatus?: string | null;
+    } | false;
+    /** The fixer status. */
+    fixer?: ThreatFixStatus;
+    /** The threat's source. */
+    source?: string;
+    /** The threat's context. */
+    context?: Record<string, unknown>;
+    /** The name of the affected file. */
+    filename?: string;
+    /** The diff showing the threat's modified file contents. */
+    diff?: string;
+    /** The affected extension. */
+    extension?: {
+        slug: string;
+        name: string;
+        version: string;
+        type: 'plugin' | 'theme' | 'core';
+    };
+};

package/build/types/threats.js

@@ -0,0 +1 @@
+export {};

package/build/utils/index.d.ts

@@ -0,0 +1,15 @@
+import { type ThreatFixStatus } from '../types/fixers.js';
+import { type Threat } from '../types/threats.js';
+export declare const getThreatType: (threat: Threat) => "plugin" | "theme" | "core" | "file";
+export declare const fixerTimestampIsStale: (lastUpdatedTimestamp: string) => boolean;
+export declare const fixerIsInError: (fixerStatus: ThreatFixStatus) => boolean;
+export declare const fixerIsInProgress: (fixerStatus: ThreatFixStatus) => boolean;
+export declare const fixerStatusIsStale: (fixerStatus: ThreatFixStatus) => boolean;
+export declare const getFixerState: (fixerStatus: ThreatFixStatus) => {
+    inProgress: boolean;
+    error: boolean;
+    stale: boolean;
+};
+export declare const getFixerAction: (threat: Threat) => string;
+export declare const getDetailedFixerAction: (threat: Threat) => string;
+export declare const getFixerDescription: (threat: Threat) => string;

package/build/utils/index.js

@@ -0,0 +1,128 @@
+import { __, sprintf } from '@wordpress/i18n';
+import { FIXER_IS_STALE_THRESHOLD } from '../constants/index.js';
+export const getThreatType = (threat) => {
+    if (threat.signature === 'Vulnerable.WP.Core') {
+        return 'core';
+    }
+    if (threat.extension) {
+        return threat.extension.type;
+    }
+    if (threat.filename) {
+        return 'file';
+    }
+    return null;
+};
+export const fixerTimestampIsStale = (lastUpdatedTimestamp) => {
+    const now = new Date();
+    const lastUpdated = new Date(lastUpdatedTimestamp);
+    return now.getTime() - lastUpdated.getTime() >= FIXER_IS_STALE_THRESHOLD;
+};
+export const fixerIsInError = (fixerStatus) => {
+    return !!('error' in fixerStatus && fixerStatus.error);
+};
+export const fixerIsInProgress = (fixerStatus) => {
+    return !!('status' in fixerStatus && fixerStatus.status === 'in_progress');
+};
+export const fixerStatusIsStale = (fixerStatus) => {
+    return (fixerIsInProgress(fixerStatus) &&
+        'lastUpdated' in fixerStatus &&
+        !!fixerTimestampIsStale(fixerStatus.lastUpdated));
+};
+export const getFixerState = (fixerStatus) => {
+    return {
+        inProgress: fixerStatus && fixerIsInProgress(fixerStatus),
+        error: fixerStatus && fixerIsInError(fixerStatus),
+        stale: fixerStatus && fixerStatusIsStale(fixerStatus),
+    };
+};
+export const getFixerAction = (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 __('Auto-fix', 'jetpack-scan');
+    }
+};
+export const getDetailedFixerAction = (threat) => {
+    var _a, _b, _c, _d;
+    switch (threat.fixable && threat.fixable.fixer) {
+        case 'delete':
+            if (threat.filename) {
+                return __('Delete file', 'jetpack-scan');
+            }
+            if (((_a = threat.extension) === null || _a === void 0 ? void 0 : _a.type) === 'plugin') {
+                return __('Delete plugin from site', 'jetpack-scan');
+            }
+            if (((_b = threat.extension) === null || _b === void 0 ? void 0 : _b.type) === 'theme') {
+                return __('Delete theme from site', 'jetpack-scan');
+            }
+            break;
+        case 'update':
+            if (((_c = threat.extension) === null || _c === void 0 ? void 0 : _c.type) === 'plugin') {
+                return __('Update plugin to newer version', 'jetpack-scan');
+            }
+            if (((_d = threat.extension) === null || _d === void 0 ? void 0 : _d.type) === 'theme') {
+                return __('Update theme to newer version', 'jetpack-scan');
+            }
+            return __('Update', 'jetpack-scan');
+            break;
+        case 'replace':
+        case 'rollback':
+            if (threat.filename) {
+                return __('Replace from backup', 'jetpack-scan');
+            }
+            if (threat.signature === 'php_hardening_WP_Config_NoSalts_001') {
+                return __('Replace default salts', 'jetpack-scan');
+            }
+            break;
+        default:
+            return __('Auto-fix', 'jetpack-scan');
+    }
+};
+export const getFixerDescription = (threat) => {
+    var _a, _b;
+    switch (threat.fixable && threat.fixable.fixer) {
+        case 'delete':
+            if (threat.filename) {
+                if (threat.filename.endsWith('/')) {
+                    return __('Delete the directory that the infected file is in.', 'jetpack-scan');
+                }
+                if (threat.signature === 'Core.File.Modification') {
+                    return __('Delete the unexpected file in a core WordPress directory.', 'jetpack-scan');
+                }
+                return __('Delete the infected file.', 'jetpack-scan');
+            }
+            if (((_a = threat.extension) === null || _a === void 0 ? void 0 : _a.type) === 'plugin') {
+                return __('Delete the plugin directory to fix the threat.', 'jetpack-scan');
+            }
+            if (((_b = threat.extension) === null || _b === void 0 ? void 0 : _b.type) === 'theme') {
+                return __('Delete 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 */
+                __('Update %1$s to version %2$s', 'jetpack-scan'), threat.extension.name, threat.fixedIn);
+            }
+            return __('Upgrade the plugin or theme to a newer version.', 'jetpack-scan');
+        case 'replace':
+        case 'rollback':
+            if (threat.filename) {
+                return threat.signature === 'Core.File.Modification'
+                    ? __('Replace the modified core WordPress file with the original clean version from the WordPress source code.', 'jetpack-scan')
+                    : __('Replace the infected file with a previously backed up version that is clean.', 'jetpack-scan');
+            }
+            if (threat.signature === 'php_hardening_WP_Config_NoSalts_001') {
+                return __('Replace the default salt keys in wp-config.php with unique ones.', 'jetpack-scan');
+            }
+            break;
+        default:
+            return __('Jetpack will auto-fix the threat.', 'jetpack-scan');
+    }
+};

package/package.json

@@ -1,7 +1,7 @@
 {
 	"private": false,
 	"name": "@automattic/jetpack-scan",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "A JS client for consuming Jetpack Scan services",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/scan/#readme",
 	"bugs": {
@@ -23,9 +23,6 @@
 	},
 	"type": "module",
 	"devDependencies": {
-		"@automattic/jetpack-webpack-config": "workspace:*",
-		"@babel/core": "7.26.0",
-		"@babel/plugin-transform-react-jsx": "7.25.9",
 		"@jest/globals": "29.7.0",
 		"@storybook/addon-actions": "8.3.5",
 		"@storybook/blocks": "8.3.5",
@@ -34,8 +31,6 @@
 		"@testing-library/react": "16.0.1",
 		"@types/jest": "29.5.12",
 		"@types/react": "18.3.12",
-		"@wordpress/babel-plugin-import-jsx-pragma": "5.12.0",
-		"babel-jest": "29.7.0",
 		"jest": "^29.7.0",
 		"jest-environment-jsdom": "29.7.0",
 		"storybook": "8.3.5",
@@ -50,18 +45,18 @@
 	"main": "./build/index.js",
 	"types": "./build/index.d.ts",
 	"dependencies": {
-		"@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",
+		"@automattic/jetpack-api": "^0.17.20",
+		"@automattic/jetpack-base-styles": "^0.6.38",
+		"@wordpress/api-fetch": "7.13.0",
+		"@wordpress/element": "6.13.0",
+		"@wordpress/i18n": "5.13.0",
+		"@wordpress/url": "4.13.0",
 		"debug": "4.3.4",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
 	"peerDependencies": {
-		"@wordpress/i18n": "5.12.0",
+		"@wordpress/i18n": "5.13.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	}

package/src/index.ts

@@ -1,3 +1,3 @@
-export * from './types';
-export * from './constants';
-export * from './utils';
+export * from './types/index.js';
+export * from './constants/index.js';
+export * from './utils/index.js';

package/src/types/fixers.ts

@@ -15,3 +15,26 @@ export type ThreatFixStatusSuccess = {
 };
 
 export type ThreatFixStatus = ThreatFixStatusError | ThreatFixStatusSuccess;
+
+/**
+ * Fixers Status
+ *
+ * Overall status of all fixers.
+ */
+type FixersStatusBase = {
+	ok: boolean; // Discriminator for overall success
+};
+
+export type FixersStatusError = FixersStatusBase & {
+	ok: false;
+	error: string;
+};
+
+export type FixersStatusSuccess = FixersStatusBase & {
+	ok: true;
+	threats: {
+		[ key: number ]: ThreatFixStatus;
+	};
+};
+
+export type FixersStatus = FixersStatusSuccess | FixersStatusError;

package/src/types/index.ts

@@ -1,2 +1,3 @@
-export * from './fixers';
-export * from './threats';
+export * from './fixers.js';
+export * from './status.js';
+export * from './threats.js';

package/src/types/status.ts

@@ -0,0 +1,33 @@
+import { Threat } from './threats.js';
+
+export type ScanStatus = {
+	/** The current status of the scanner. */
+	status: 'unavailable' | 'provisioning' | 'idle' | 'scanning' | 'scheduled';
+
+	/** The IDs of fixable threats. */
+	fixableThreatIds: number[];
+
+	/** The current scan progress, only available from the Scan API. */
+	currentProgress: number | null;
+
+	/** The data source for the scan status. */
+	dataSource: 'protect_report' | 'scan_api';
+
+	/** Whether the site currently has extensions not checked in the latest scan. */
+	hasUncheckedItems: boolean;
+
+	/** The time the last scan was checked, in YYYY-MM-DD HH:MM:SS format. */
+	lastChecked: string | null;
+
+	/** Whether there was an error in the scan results. */
+	error: boolean | null;
+
+	/** The error code. */
+	errorCode: string | null;
+
+	/** The error message. */
+	errorMessage: string | null;
+
+	/** The detected threats. */
+	threats: Threat[];
+};

package/src/types/threats.ts

@@ -1,4 +1,4 @@
-import { ThreatFixStatus } from '..';
+import { ThreatFixStatus } from './fixers.js';
 
 export type ThreatStatus = 'fixed' | 'ignored' | 'current';
 

package/src/utils/index.ts

@@ -1,5 +1,7 @@
 import { __, sprintf } from '@wordpress/i18n';
-import { Threat, ThreatFixStatus, FIXER_IS_STALE_THRESHOLD } from '..';
+import { FIXER_IS_STALE_THRESHOLD } from '../constants/index.js';
+import { type ThreatFixStatus } from '../types/fixers.js';
+import { type Threat } from '../types/threats.js';
 
 export const getThreatType = ( threat: Threat ) => {
 	if ( threat.signature === 'Vulnerable.WP.Core' ) {