@automattic/jetpack-boost-score-api 0.1.5 → 0.1.7

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.1.7] - 2023-08-28
+### Added
+- New section to display boost history on jetpack boost admin page [#32016]
+
+### Changed
+- Updated package dependencies. [#32605]
+
+## [0.1.6] - 2023-08-09
+### Changed
+- Updated package dependencies. [#32166]
+
 ## [0.1.5] - 2023-07-17
 ### Changed
 - Updated package dependencies. [#31815]
@@ -35,6 +46,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Create package for the boost score bar API [#30781]
 
+[0.1.7]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.6...v0.1.7
+[0.1.6]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.5...v0.1.6
 [0.1.5]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.4...v0.1.5
 [0.1.4]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.3...v0.1.4
 [0.1.3]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.2...v0.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/jetpack-boost-score-api",
-	"version": "0.1.5",
+	"version": "0.1.7",
 	"description": "A package to get the Jetpack Boost score of a site",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/boost-score-api/#readme",
 	"bugs": {
@@ -20,7 +20,7 @@
 		"test": "jest tests"
 	},
 	"dependencies": {
-		"@wordpress/i18n": "4.37.0",
+		"@wordpress/i18n": "4.38.0",
 		"zod": "3.20.2"
 	},
 	"devDependencies": {

package/src/index.ts

@@ -20,6 +20,43 @@ type SpeedScoresSet = {
 	isStale: boolean;
 };
 
+interface ScoreValue {
+	score: number;
+	value: number;
+}
+
+interface SpeedHistoryDimension {
+	mobile_overall_score: number;
+	desktop_overall_score: number;
+	mobile_lcp: ScoreValue;
+	desktop_lcp: ScoreValue;
+	mobile_tbt: ScoreValue;
+	desktop_tbt: ScoreValue;
+	mobile_cls: ScoreValue;
+	desktop_cls: ScoreValue;
+	mobile_si: ScoreValue;
+	desktop_si: ScoreValue;
+	mobile_tti: ScoreValue;
+	desktop_tti: ScoreValue;
+	mobile_fcp: ScoreValue;
+	desktop_fcp: ScoreValue;
+}
+
+interface SpeedHistoryPeriod {
+	timestamp: number;
+	dimensions: SpeedHistoryDimension[];
+}
+
+interface SpeedHistoryResponse {
+	data: {
+		_meta: {
+			start: number;
+			end: number;
+		};
+		periods: SpeedHistoryPeriod[];
+	};
+}
+
 type ParsedApiResponse = {
 	status: string;
 	scores?: SpeedScoresSet;
@@ -60,6 +97,32 @@ export async function requestSpeedScores(
 	return await pollRequest( rootUrl, siteUrl, nonce );
 }
 
+/**
+ * Get SpeedScores gistory to render the Graph.  Will automatically
+ * poll for a response until the task is done, returning a SpeedHistory object.
+ *
+ * @param {string} rootUrl - Root URL for the HTTP request.
+ * @param {string} siteUrl - URL of the site.
+ * @param {string} nonce - Nonce to use for authentication.
+ * @returns {SpeedHistoryResponse} Speed score history returned by the server.
+ */
+export async function requestSpeedScoresHistory(
+	rootUrl: string,
+	siteUrl: string,
+	nonce: string
+): Promise< SpeedHistoryResponse > {
+	const end = new Date().getTime();
+	const start = end - 1000 * 60 * 60 * 24 * 30; // 30 days ago
+	// Request metrics
+	const response = await api.post< SpeedHistoryResponse >(
+		rootUrl,
+		'/speed-scores-history',
+		{ start, end },
+		nonce
+	);
+	return response;
+}
+
 /**
  * Helper method for parsing a response from a speed score API request. Returns
  * scores (if ready), and a status (success|pending|error).