@automattic/jetpack-boost-score-api 0.1.34 → 0.1.36

package/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.36] - 2024-08-23
+### Changed
+- Updated package dependencies. [#39004]
+
+## [0.1.35] - 2024-08-21
+### Changed
+- Internal updates.
+
 ## [0.1.34] - 2024-08-15
 ### Changed
 - Updated package dependencies. [#38662]
@@ -151,6 +159,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.36]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.35...v0.1.36
+[0.1.35]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.34...v0.1.35
 [0.1.34]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.33...v0.1.34
 [0.1.33]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.32...v0.1.33
 [0.1.32]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.31...v0.1.32

package/build/api.d.ts

@@ -2,20 +2,20 @@ import type { JSONObject } from './utils/json-object-type';
 /**
  * Make a GET request to the Boost REST API.
  *
- * @param {string} root - The root URL to use.
- * @param {string} path - The path to the endpoint.
+ * @param {string} root  - The root URL to use.
+ * @param {string} path  - The path to the endpoint.
  * @param {string} nonce - The nonce to use.
- * @returns {Promise} - The response.
+ * @return {Promise} - The response.
  */
 declare function get<T = JSONObject>(root: string, path: string, nonce: string): Promise<T>;
 /**
  * Make a POST request to the Boost REST API.
  *
- * @param {string} root - The root URL to use.
- * @param {string} path - The path to the endpoint.
- * @param {null | JSONObject} body - The body of the request.
- * @param {string} nonce - The nonce to use.
- * @returns {Promise} - The response.
+ * @param {string}            root  - The root URL to use.
+ * @param {string}            path  - The path to the endpoint.
+ * @param {null | JSONObject} body  - The body of the request.
+ * @param {string}            nonce - The nonce to use.
+ * @return {Promise} - The response.
  */
 declare function post<T = JSONObject>(root: string, path: string, body: JSONObject | null, nonce: string): Promise<T>;
 declare const _default: {

package/build/index.d.ts

@@ -44,11 +44,11 @@ interface SpeedHistoryResponse {
  * Kick off a request to generate speed scores for this site. Will automatically
  * poll for a response until the task is done, returning a SpeedScores object.
  *
- * @param {boolean} force - Force regenerate speed scores.
- * @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 {SpeedScoresSet} Speed scores returned by the server.
+ * @param {boolean} force   - Force regenerate speed scores.
+ * @param {string}  rootUrl - Root URL for the HTTP request.
+ * @param {string}  siteUrl - URL of the site.
+ * @param {string}  nonce   - Nonce to use for authentication.
+ * @return {SpeedScoresSet} Speed scores returned by the server.
  */
 export declare function requestSpeedScores(force: boolean, rootUrl: string, siteUrl: string, nonce: string): Promise<SpeedScoresSet>;
 /**
@@ -57,8 +57,8 @@ export declare function requestSpeedScores(force: boolean, rootUrl: string, site
  *
  * @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.
+ * @param {string} nonce   - Nonce to use for authentication.
+ * @return {SpeedHistoryResponse} Speed score history returned by the server.
  */
 export declare function requestSpeedScoresHistory(rootUrl: string, siteUrl: string, nonce: string): Promise<SpeedHistoryResponse>;
 /**
@@ -67,7 +67,7 @@ export declare function requestSpeedScoresHistory(rootUrl: string, siteUrl: stri
  *
  * @param {number} mobile  - Mobile speed score
  * @param {number} desktop - Desktop speed score
- * @returns {string} letter score
+ * @return {string} letter score
  */
 export declare function getScoreLetter(mobile: number, desktop: number): string;
 /**
@@ -75,21 +75,21 @@ export declare function getScoreLetter(mobile: number, desktop: number): string;
  * The message varies depending on the results of the speed scores so lets modify this
  *
  * @param {SpeedScoresSet} scores - Speed scores returned by the server.
- * @returns {boolean} true if scores changed.
+ * @return {boolean} true if scores changed.
  */
 export declare function didScoresChange(scores: SpeedScoresSet): boolean;
 /**
  * Determine the change in scores to pass through to other functions.
  *
  * @param {SpeedScoresSet} scores - Speed scores returned by the server.
- * @returns {number} - The change in scores in percentage.
+ * @return {number} - The change in scores in percentage.
  */
 export declare function getScoreMovementPercentage(scores: SpeedScoresSet): number;
 /**
  * Determine the number of days since the last timestamp.
  *
  * @param {number} timestamp - the timestamp returned by the server.
- * @returns {number} - The number of days.
+ * @return {number} - The number of days.
  */
 export declare function calculateDaysSince(timestamp: number): number;
 export {};

package/build/utils/cast-to-number.d.ts

@@ -6,6 +6,6 @@
  * @template DefaultType
  * @param {*}           value        - External value to process as a number
  * @param {DefaultType} defaultValue - Default value to return if not a number.
- * @returns {number | DefaultType} value as a number, of defaultValue.
+ * @return {number | DefaultType} value as a number, of defaultValue.
  */
 export declare function castToNumber<DefaultType = number>(value: unknown, defaultValue?: DefaultType): number | DefaultType;

package/build/utils/cast-to-string.d.ts

@@ -6,6 +6,6 @@
  * @template DefaultType
  * @param {*}           value        - External value to process as a string
  * @param {DefaultType} defaultValue - Default value to return if not a string
- * @returns {string | DefaultType} value as a string, of defaultValue.
+ * @return {string | DefaultType} value as a string, of defaultValue.
  */
 export declare function castToString<DefaultType = undefined>(value: unknown, defaultValue?: DefaultType | undefined): string | DefaultType | undefined;

package/build/utils/json-types.d.ts

@@ -12,7 +12,7 @@ export type JSONValue = string | number | boolean | JSONObject | JSONArray | nul
  * Returns true if the given JSONValue is a JSONObject.
  *
  * @param {JSONValue} value - Value to check.
- * @returns {boolean} True if the given value is a JSONObject.
+ * @return {boolean} True if the given value is a JSONObject.
  */
 export declare function isJsonObject(value: JSONValue): value is JSONObject;
 /**
@@ -20,6 +20,6 @@ export declare function isJsonObject(value: JSONValue): value is JSONObject;
  * Sure, you could use x instanceof Array but this is shorter and more consistent.
  *
  * @param {JSONValue} value - Value to check.
- * @returns {boolean} True if the given value is a JSONArray.
+ * @return {boolean} True if the given value is a JSONArray.
  */
 export declare function isJsonArray(value: JSONValue): value is JSONArray;

package/build/utils/poll-promise.d.ts

@@ -18,7 +18,7 @@ type PollPromiseArgs<RetType = void> = {
  * @param {number}   obj.timeout      - Milliseconds before rejecting w/ a timeout
  * @param {Function} obj.callback     - Callback to call every <interval> ms.
  * @param {string}   obj.timeoutError - Message to throw on timeout.
- * @returns {Promise< RetType >} - A promise which resolves to the value resolved() inside callback.
+ * @return {Promise< RetType >} - A promise which resolves to the value resolved() inside callback.
  */
 export default function pollPromise<RetType = void>({ interval, callback, timeout, timeoutError, }: PollPromiseArgs<RetType>): Promise<RetType>;
 export {};

package/build/utils/standardize-error.d.ts

@@ -5,6 +5,6 @@ import type { JSONValue } from './json-types';
  *
  * @param {*}               data           - Any thrown error data to interpret as an Error (or subclass)
  * @param {JSONValue|Error} defaultMessage - A default message to throw if no sensible error can be found.
- * @returns {Error} the data guaranteed to be an Error or subclass thereof.
+ * @return {Error} the data guaranteed to be an Error or subclass thereof.
  */
 export declare function standardizeError(data: JSONValue | Error, defaultMessage?: string): Error;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/jetpack-boost-score-api",
-	"version": "0.1.34",
+	"version": "0.1.36",
 	"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": {