@automattic/jetpack-scan 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -5,6 +5,13 @@ 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]
@@ -72,6 +79,7 @@ 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

package/build/types/fixers.d.ts

@@ -12,3 +12,23 @@ export type ThreatFixStatusSuccess = {
     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/index.d.ts

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

package/build/types/index.js

@@ -1,2 +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/package.json

@@ -1,7 +1,7 @@
 {
 	"private": false,
 	"name": "@automattic/jetpack-scan",
-	"version": "0.4.1",
+	"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": {
@@ -45,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/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.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[];
+};