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

package/CHANGELOG.md

@@ -5,6 +5,10 @@ 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.8] - 2023-09-01
+### Removed
+- Remove unnecessary files from mirror repo and published package. [#32674]
+
 ## [0.1.7] - 2023-08-28
 ### Added
 - New section to display boost history on jetpack boost admin page [#32016]
@@ -46,6 +50,7 @@ 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.8]: https://github.com/Automattic/jetpack-boost-score-api/compare/v0.1.7...v0.1.8
 [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

package/build/api-error.d.ts

@@ -0,0 +1,14 @@
+import type { JSONObject } from './utils/json-object-type';
+/**
+ * Special error subclass returned by API Calls with extra
+ * information.
+ */
+export declare class ApiError extends Error {
+    readonly httpCode: number;
+    readonly body: JSONObject | string | null;
+    readonly parseError: Error | null;
+    constructor(httpCode: number, body: JSONObject | string | null, parseError: Error | null);
+    get message(): string;
+    getDisplayBody(): string;
+    getRestApiErrorMessage(): string;
+}

package/build/api.d.ts

@@ -0,0 +1,25 @@
+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} nonce - The nonce to use.
+ * @returns {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.
+ */
+declare function post<T = JSONObject>(root: string, path: string, body: JSONObject | null, nonce: string): Promise<T>;
+declare const _default: {
+    get: typeof get;
+    post: typeof post;
+};
+export default _default;

package/build/config.d.ts

@@ -0,0 +1,2 @@
+export declare const JETPACK_BOOST_REST_NAMESPACE = "jetpack-boost/v1";
+export declare const JETPACK_BOOST_REST_PREFIX = "";

package/build/index.asset.php

@@ -0,0 +1 @@
+<?php return array('dependencies' => array('wp-i18n'), 'version' => '58dd44b48c4070487c17');

package/build/index.d.ts

@@ -0,0 +1,88 @@
+type SpeedScores = {
+    mobile: number;
+    desktop: number;
+};
+type SpeedScoresSet = {
+    current: SpeedScores;
+    noBoost: SpeedScores;
+    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[];
+    };
+}
+/**
+ * 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.
+ */
+export declare function requestSpeedScores(force: boolean, rootUrl: string, siteUrl: string, nonce: string): Promise<SpeedScoresSet>;
+/**
+ * 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 declare function requestSpeedScoresHistory(rootUrl: string, siteUrl: string, nonce: string): Promise<SpeedHistoryResponse>;
+/**
+ * Given a mobile and desktop score, return a letter summarizing the overall
+ * score.
+ *
+ * @param {number} mobile  - Mobile speed score
+ * @param {number} desktop - Desktop speed score
+ * @returns {string} letter score
+ */
+export declare function getScoreLetter(mobile: number, desktop: number): string;
+/**
+ * Find out if site scores changed. We fire a popout modal if they improve or worsen.
+ * 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.
+ */
+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.
+ */
+export declare function getScoreMovementPercentage(scores: SpeedScoresSet): number;
+export {};

package/build/index.js

@@ -0,0 +1,7 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.BoostScoreApiLibrary=t():e.BoostScoreApiLibrary=t()}(self,(()=>(()=>{"use strict";var e={477:(e,t,r)=>{r.d(t,{M:()=>c});var n,o=r(736),i=r(752),s=r(283),u=(n=function(e,t){return n=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)Object.prototype.hasOwnProperty.call(t,r)&&(e[r]=t[r])},n(e,t)},function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Class extends value "+String(t)+" is not a constructor or null");function __(){this.constructor=e}n(e,t),e.prototype=null===t?Object.create(t):(__.prototype=t.prototype,new __)}),c=function(e){function t(t,r,n){var o=e.call(this)||this;return o.httpCode=t,o.body=r,o.parseError=n,o}return u(t,e),Object.defineProperty(t.prototype,"message",{get:function(){switch(this.httpCode){case 403:return this.getRestApiErrorMessage();case 200:if(this.parseError)return(0,o.sprintf)(
+/* Translators: %s refers to a browser-supplied error message (hopefully already in the right language) */
+(0,o.__)("Received invalid response while communicating with your WordPress site: %s","boost-score-api"),this.parseError.message)}return(0,o.sprintf)(
+/* Translators: %d refers to numeric HTTP error code */
+(0,o.__)("HTTP %d error received while communicating with the server.","boost-score-api"),this.httpCode)},enumerable:!1,configurable:!0}),t.prototype.getDisplayBody=function(){return(0,s.b)(this.body)?JSON.stringify(this.body,null,"  "):(0,i.x)(this.body,"").substring(0,1e3)},t.prototype.getRestApiErrorMessage=function(){return(0,o.__)("Your site's REST API does not seem to be accessible. Jetpack Boost requires access to your REST API in order to receive site performance scores. Please make sure that your site's REST API is active and accessible, and try again.","boost-score-api")},t}(Error)},655:(e,t,r)=>{r.d(t,{Z:()=>l});var n=r(736),o=r(477),i=r(73),s=function(e,t,r,n){return new(r||(r=Promise))((function(o,i){function s(e){try{c(n.next(e))}catch(e){i(e)}}function u(e){try{c(n.throw(e))}catch(e){i(e)}}function c(e){var t;e.done?o(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(s,u)}c((n=n.apply(e,t||[])).next())}))},u=function(e,t){var r,n,o,i,s={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:u(0),throw:u(1),return:u(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function u(u){return function(c){return function(u){if(r)throw new TypeError("Generator is already executing.");for(;i&&(i=0,u[0]&&(s=0)),s;)try{if(r=1,n&&(o=2&u[0]?n.return:u[0]?n.throw||((o=n.return)&&o.call(n),0):n.next)&&!(o=o.call(n,u[1])).done)return o;switch(n=0,o&&(u=[2&u[0],o.value]),u[0]){case 0:case 1:o=u;break;case 4:return s.label++,{value:u[1],done:!1};case 5:s.label++,n=u[1],u=[0];continue;case 7:u=s.ops.pop(),s.trys.pop();continue;default:if(!(o=s.trys,(o=o.length>0&&o[o.length-1])||6!==u[0]&&2!==u[0])){s=0;continue}if(3===u[0]&&(!o||u[1]>o[0]&&u[1]<o[3])){s.label=u[1];break}if(6===u[0]&&s.label<o[1]){s.label=o[1],o=u;break}if(o&&s.label<o[2]){s.label=o[2],s.ops.push(u);break}o[2]&&s.ops.pop(),s.trys.pop();continue}u=t.call(e,s)}catch(e){u=[6,e],n=0}finally{r=o=0}if(5&u[0])throw u[1];return{value:u[0]?u[1]:void 0,done:!0}}([u,c])}}};function c(e,t,r,o,c){return void 0===o&&(o=null),s(this,void 0,void 0,(function(){var s,a,l,f,p,d;return u(this,(function(u){switch(u.label){case 0:s={method:e,mode:"cors",headers:{"X-WP-Nonce":c}},"post"!==e&&"delete"!==e||!o||(s.body=JSON.stringify(o),s.headers["Content-Type"]="application/json"),a=function(e,t){return t+i.N+i.L+e}(r,t),u.label=1;case 1:return u.trys.push([1,3,,4]),[4,fetch(a,s)];case 2:return l=u.sent(),[3,4];case 3:throw f=u.sent(),delete(p=s).body,delete p.headers["X-WP-Nonce"],d={requestInitiator:window.location.href,requestUrl:a,requestArgs:p,originalErrorMessage:f.toString()},new Error((0,n.sprintf)(
+/* Translators: %s refers to a string representation of an error object containing useful debug information  */
+(0,n.__)("An error occurred while trying to communicate with the site REST API. Extra debug info: %s","boost-score-api"),JSON.stringify(d)));case 4:return[2,l]}}))}))}function a(e,t,r,n,i){return void 0===n&&(n=null),s(this,void 0,void 0,(function(){var s,a,l,f;return u(this,(function(u){switch(u.label){case 0:return[4,c(e,t,r,n,i)];case 1:s=u.sent(),u.label=2;case 2:return u.trys.push([2,4,,5]),[4,s.text()];case 3:return a=u.sent(),[3,5];case 4:throw l=u.sent(),new o.M(s.status,null,l);case 5:try{f=JSON.parse(a)}catch(e){throw new o.M(s.status,a,e)}if(!s.ok)throw new o.M(s.status,f,null);return[2,f]}}))}))}const l={get:function(e,t,r){return a("get",e,t,null,r)},post:function(e,t,r,n){return void 0===r&&(r=null),a("post",e,t,r,n)}}},73:(e,t,r)=>{r.d(t,{L:()=>o,N:()=>n});var n="jetpack-boost/v1",o=""},194:(e,t,r)=>{function n(e,t){if(void 0===t&&(t=void 0),"number"==typeof e)return e;if("string"==typeof e){var r=parseFloat(e);if(!isNaN(r))return r}return t}r.d(t,{W:()=>n})},752:(e,t,r)=>{function n(e,t){return void 0===t&&(t=void 0),"string"==typeof e?e:e&&e.toString instanceof Function?e.toString():t}r.d(t,{x:()=>n})},283:(e,t,r)=>{function n(e){return!!e&&e instanceof Object&&!(e instanceof Array)}r.d(t,{b:()=>n})},281:(e,t,r)=>{r.d(t,{Z:()=>s});var n=r(736),o=function(e,t,r,n){return new(r||(r=Promise))((function(o,i){function s(e){try{c(n.next(e))}catch(e){i(e)}}function u(e){try{c(n.throw(e))}catch(e){i(e)}}function c(e){var t;e.done?o(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(s,u)}c((n=n.apply(e,t||[])).next())}))},i=function(e,t){var r,n,o,i,s={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:u(0),throw:u(1),return:u(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function u(u){return function(c){return function(u){if(r)throw new TypeError("Generator is already executing.");for(;i&&(i=0,u[0]&&(s=0)),s;)try{if(r=1,n&&(o=2&u[0]?n.return:u[0]?n.throw||((o=n.return)&&o.call(n),0):n.next)&&!(o=o.call(n,u[1])).done)return o;switch(n=0,o&&(u=[2&u[0],o.value]),u[0]){case 0:case 1:o=u;break;case 4:return s.label++,{value:u[1],done:!1};case 5:s.label++,n=u[1],u=[0];continue;case 7:u=s.ops.pop(),s.trys.pop();continue;default:if(!(o=s.trys,(o=o.length>0&&o[o.length-1])||6!==u[0]&&2!==u[0])){s=0;continue}if(3===u[0]&&(!o||u[1]>o[0]&&u[1]<o[3])){s.label=u[1];break}if(6===u[0]&&s.label<o[1]){s.label=o[1],o=u;break}if(o&&s.label<o[2]){s.label=o[2],s.ops.push(u);break}o[2]&&s.ops.pop(),s.trys.pop();continue}u=t.call(e,s)}catch(e){u=[6,e],n=0}finally{r=o=0}if(5&u[0])throw u[1];return{value:u[0]?u[1]:void 0,done:!0}}([u,c])}}};function s(e){var t=e.interval,r=e.callback,s=e.timeout,u=e.timeoutError;return o(this,void 0,void 0,(function(){var e,c,a=this;return i(this,(function(l){return[2,new Promise((function(l,f){e=setTimeout((function(){f(new Error(u||(0,n.__)("Timed out","boost-score-api")))}),s||12e4),c=setInterval((function(){return o(a,void 0,void 0,(function(){var e;return i(this,(function(t){switch(t.label){case 0:return t.trys.push([0,2,,3]),[4,Promise.resolve(r(l))];case 1:return t.sent(),[3,3];case 2:return e=t.sent(),f(e),[3,3];case 3:return[2]}}))}))}),t)})).finally((function(){clearTimeout(e),clearInterval(c)}))]}))}))}},595:(e,t,r)=>{function n(e,t){return e instanceof Error?e:"string"==typeof e||e instanceof String?new Error(e.toString()):e.message?new Error(e.message):t?new Error(t):new Error(JSON.stringify(e))}r.d(t,{V:()=>n})},736:e=>{e.exports=window.wp.i18n}},t={};function r(n){var o=t[n];if(void 0!==o)return o.exports;var i=t[n]={exports:{}};return e[n](i,i.exports,r),i.exports}r.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return r.d(t,{a:t}),t},r.d=(e,t)=>{for(var n in t)r.o(t,n)&&!r.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},r.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var n={};return(()=>{r.r(n),r.d(n,{didScoresChange:()=>w,getScoreLetter:()=>v,getScoreMovementPercentage:()=>g,requestSpeedScores:()=>d,requestSpeedScoresHistory:()=>h});var e=r(736),t=r(655),o=r(194),i=r(752),s=r(283),u=r(281),c=r(595),a=function(e,t,r,n){return new(r||(r=Promise))((function(o,i){function s(e){try{c(n.next(e))}catch(e){i(e)}}function u(e){try{c(n.throw(e))}catch(e){i(e)}}function c(e){var t;e.done?o(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(s,u)}c((n=n.apply(e,t||[])).next())}))},l=function(e,t){var r,n,o,i,s={label:0,sent:function(){if(1&o[0])throw o[1];return o[1]},trys:[],ops:[]};return i={next:u(0),throw:u(1),return:u(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function u(u){return function(c){return function(u){if(r)throw new TypeError("Generator is already executing.");for(;i&&(i=0,u[0]&&(s=0)),s;)try{if(r=1,n&&(o=2&u[0]?n.return:u[0]?n.throw||((o=n.return)&&o.call(n),0):n.next)&&!(o=o.call(n,u[1])).done)return o;switch(n=0,o&&(u=[2&u[0],o.value]),u[0]){case 0:case 1:o=u;break;case 4:return s.label++,{value:u[1],done:!1};case 5:s.label++,n=u[1],u=[0];continue;case 7:u=s.ops.pop(),s.trys.pop();continue;default:if(!(o=s.trys,(o=o.length>0&&o[o.length-1])||6!==u[0]&&2!==u[0])){s=0;continue}if(3===u[0]&&(!o||u[1]>o[0]&&u[1]<o[3])){s.label=u[1];break}if(6===u[0]&&s.label<o[1]){s.label=o[1],o=u;break}if(o&&s.label<o[2]){s.label=o[2],s.ops.push(u);break}o[2]&&s.ops.pop(),s.trys.pop();continue}u=t.call(e,s)}catch(e){u=[6,e],n=0}finally{r=o=0}if(5&u[0])throw u[1];return{value:u[0]?u[1]:void 0,done:!0}}([u,c])}}},f=12e4,p=5e3;function d(e,r,n,o){return void 0===e&&(e=!1),a(this,void 0,void 0,(function(){var i,s;return l(this,(function(u){switch(u.label){case 0:return s=b,[4,t.Z.post(r,e?"/speed-scores/refresh":"/speed-scores",{url:n},o)];case 1:return(i=s.apply(void 0,[u.sent()])).scores?[2,i.scores]:[4,y(r,n,o)];case 2:return[2,u.sent()]}}))}))}function h(e,r,n){return a(this,void 0,void 0,(function(){var r,o;return l(this,(function(i){switch(i.label){case 0:return r=(new Date).getTime(),o=r-2592e6,[4,t.Z.post(e,"/speed-scores-history",{start:o,end:r},n)];case 1:return[2,i.sent()]}}))}))}function b(t){if(t.error){var r=(0,e.__)("An unknown error occurred while requesting metrics","boost-score-api");throw(0,c.V)(t.error,r)}if((0,s.b)(t.scores))return{status:"success",scores:{current:(0,s.b)(t.scores.current)?{mobile:(0,o.W)(t.scores.current.mobile,0),desktop:(0,o.W)(t.scores.current.desktop,0)}:{mobile:0,desktop:0},noBoost:(0,s.b)(t.scores.noBoost)?{mobile:(0,o.W)(t.scores.noBoost.mobile,0),desktop:(0,o.W)(t.scores.noBoost.desktop,0)}:null,isStale:!!t.scores.isStale}};var n=(0,i.x)(t.status);if(!n)throw new Error((0,e.__)("Invalid response while requesting metrics","boost-score-api"));return{status:n}}function y(r,n,o){return a(this,void 0,void 0,(function(){var i=this;return l(this,(function(s){return[2,(0,u.Z)({timeout:f,interval:p,timeoutError:(0,e.__)("Timed out while waiting for speed-score.","boost-score-api"),callback:function(e){return a(i,void 0,void 0,(function(){var i,s;return l(this,(function(u){switch(u.label){case 0:return s=b,[4,t.Z.post(r,"/speed-scores",{url:n},o)];case 1:return(i=s.apply(void 0,[u.sent()])).scores&&e(i.scores),[2]}}))}))}})]}))}))}function v(e,t){var r=(e+t)/2;return r>90?"A":r>75?"B":r>50?"C":r>35?"D":r>25?"E":"F"}function w(e){var t=e.current,r=e.noBoost;return null!=t&&null!=r&&(t.mobile!==r.mobile||t.desktop!==r.desktop)}function g(e){var t=e.current,r=e.noBoost;if(null!==t&&null!==r){var n=(e.current.mobile+e.current.desktop)/(e.noBoost.mobile+e.noBoost.desktop)-1;return Math.round(100*n)}return 0}})(),n})()));

package/{src/utils/cast-to-number.ts → build/utils/cast-to-number.d.ts}

@@ -8,20 +8,4 @@
  * @param {DefaultType} defaultValue - Default value to return if not a number.
  * @returns {number | DefaultType} value as a number, of defaultValue.
  */
-export function castToNumber< DefaultType = number >(
-	value: unknown,
-	defaultValue: DefaultType = undefined
-): number | DefaultType {
-	if ( typeof value === 'number' ) {
-		return value;
-	}
-
-	if ( typeof value === 'string' ) {
-		const float = parseFloat( value );
-		if ( ! isNaN( float ) ) {
-			return float;
-		}
-	}
-
-	return defaultValue;
-}
+export declare function castToNumber<DefaultType = number>(value: unknown, defaultValue?: DefaultType): number | DefaultType;

package/{src/utils/cast-to-string.ts → build/utils/cast-to-string.d.ts}

@@ -8,21 +8,4 @@
  * @param {DefaultType} defaultValue - Default value to return if not a string
  * @returns {string | DefaultType} value as a string, of defaultValue.
  */
-export function castToString< DefaultType = undefined >(
-	value: unknown,
-	defaultValue: DefaultType | undefined = undefined
-): string | DefaultType | undefined {
-	if ( typeof value === 'string' ) {
-		return value;
-	}
-
-	if ( ! value ) {
-		return defaultValue;
-	}
-
-	if ( value.toString instanceof Function ) {
-		return value.toString();
-	}
-
-	return defaultValue;
-}
+export declare function castToString<DefaultType = undefined>(value: unknown, defaultValue?: DefaultType | undefined): string | DefaultType | undefined;

package/{src/utils/json-object-type.ts → build/utils/json-object-type.d.ts}

@@ -1,12 +1,14 @@
 import { z } from 'zod';
-
 /**
  * Definition for JSON types:
  * - JSONValue can be any value compatible with JSON; an object (containing JSONValues), array, string, number, boolean, or null
  * - JSONObject is an object containing JSONValues
  * - JSONSchema is a zod schema that can be used to validate JSONValues
  */
-const literalSchema = z.union( [ z.string(), z.number(), z.boolean(), z.null() ] );
-type Literal = z.infer< typeof literalSchema >;
+declare const literalSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+type Literal = z.infer<typeof literalSchema>;
 export type JSONValue = Literal | JSONObject | JSONValue[];
-export type JSONObject = { [ key: string ]: JSONValue };
+export type JSONObject = {
+    [key: string]: JSONValue;
+};
+export {};

package/{src/utils/json-types.ts → build/utils/json-types.d.ts}

@@ -1,25 +1,20 @@
-/* eslint-disable no-use-before-define */
 /**
  * Generic type for handling JSON-like objects.
  *
  * Use this as a last resort if you can't reasonably describe the possible shapes an object can take.
  */
 export type JSONObject = {
-	[ key: string ]: JSONValue;
+    [key: string]: JSONValue;
 };
 export type JSONArray = JSONValue[];
 export type JSONValue = string | number | boolean | JSONObject | JSONArray | null | undefined;
-
 /**
  * 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.
  */
-export function isJsonObject( value: JSONValue ): value is JSONObject {
-	return !! value && value instanceof Object && ! ( value instanceof Array );
-}
-
+export declare function isJsonObject(value: JSONValue): value is JSONObject;
 /**
  * Returns true if the given JSONValue is a JSONArray.
  * Sure, you could use x instanceof Array but this is shorter and more consistent.
@@ -27,6 +22,4 @@ export function isJsonObject( value: JSONValue ): value is JSONObject {
  * @param {JSONValue} value - Value to check.
  * @returns {boolean} True if the given value is a JSONArray.
  */
-export function isJsonArray( value: JSONValue ): value is JSONArray {
-	return value instanceof Array;
-}
+export declare function isJsonArray(value: JSONValue): value is JSONArray;

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

@@ -0,0 +1,24 @@
+type Resolve<RetType = void> = (value: RetType | PromiseLike<RetType>) => void;
+type PollPromiseArgs<RetType = void> = {
+    interval: number;
+    timeout: number;
+    timeoutError?: string;
+    callback: (resolve: Resolve<RetType>) => Promise<void> | void;
+};
+/**
+ * Repeatedly poll callback every <interval> milliseconds until it calls the
+ * resolve() callback. If the callback throws an error, the whole polling
+ * promise will reject.
+ *
+ * Rejects with a timeout after <timeout> milliseconds.
+ *
+ * @template RetType
+ * @param {object}   obj              - Arguments object.
+ * @param {number}   obj.interval     - Milliseconds between calling callback
+ * @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.
+ */
+export default function pollPromise<RetType = void>({ interval, callback, timeout, timeoutError, }: PollPromiseArgs<RetType>): Promise<RetType>;
+export {};

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

@@ -0,0 +1,10 @@
+import type { JSONValue } from './json-types';
+/**
+ * JavaScript offers no guarantee that caught objects in catch blocks are actually
+ * Error objects. This method fixes that, for type safety. :)
+ *
+ * @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.
+ */
+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.7",
+	"version": "0.1.8",
 	"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": {

package/.gitattributes

@@ -1,16 +0,0 @@
-# Files not needed to be distributed in the package.
-.gitattributes    export-ignore
-node_modules      export-ignore
-package.json      export-ignore
-
-/build/**         production-exclude
-
-# Files to exclude from the mirror repo
-/changelog/**     production-exclude
-/.eslintrc.cjs    production-exclude
-.gitignore        production-exclude
-tests/**          production-exclude
-babel.config.js   production-exclude
-webpack.config.js production-exclude
-tsconfig.json     production-exclude
-

package/babel.config.cjs

@@ -1,10 +0,0 @@
-module.exports = {
-	presets: [
-		[
-			'@automattic/jetpack-webpack-config/babel/preset',
-			{
-				/* options */
-			},
-		],
-	],
-};

package/src/api-error.ts

@@ -1,65 +0,0 @@
-import { __, sprintf } from '@wordpress/i18n';
-import { castToString } from './utils/cast-to-string';
-import { isJsonObject } from './utils/json-types';
-import type { JSONObject } from './utils/json-object-type';
-
-/**
- * Special error subclass returned by API Calls with extra
- * information.
- */
-export class ApiError extends Error {
-	public constructor(
-		public readonly httpCode: number,
-		public readonly body: JSONObject | string | null,
-		public readonly parseError: Error | null
-	) {
-		super();
-	}
-
-	// Override Error.message to generate a message based on http code and json body.
-	get message(): string {
-		switch ( this.httpCode ) {
-			case 403: {
-				return this.getRestApiErrorMessage();
-			}
-
-			// For HTTP 200 responses, look for JSON parsing issues.
-			case 200: {
-				if ( this.parseError ) {
-					return sprintf(
-						/* Translators: %s refers to a browser-supplied error message (hopefully already in the right language) */
-						__(
-							'Received invalid response while communicating with your WordPress site: %s',
-							'boost-score-api'
-						),
-						this.parseError.message
-					);
-				}
-
-				break;
-			}
-		}
-
-		return sprintf(
-			/* Translators: %d refers to numeric HTTP error code */
-			__( 'HTTP %d error received while communicating with the server.', 'boost-score-api' ),
-			this.httpCode
-		);
-	}
-
-	// Returns the body of this in a string format for display. Pretty printed JSON if valid, raw dump if not.
-	public getDisplayBody(): string {
-		if ( isJsonObject( this.body ) ) {
-			return JSON.stringify( this.body, null, '  ' );
-		}
-		return castToString( this.body, '' ).substring( 0, 1000 );
-	}
-
-	// Returns an error message appropriate for a site whose API doesn't seem to be available.
-	getRestApiErrorMessage(): string {
-		return __(
-			"Your site's REST API does not seem to be accessible. Jetpack Boost requires access to your REST API in order to receive site performance scores. Please make sure that your site's REST API is active and accessible, and try again.",
-			'boost-score-api'
-		);
-	}
-}

package/src/api.ts

@@ -1,156 +0,0 @@
-import { __, sprintf } from '@wordpress/i18n';
-import { ApiError } from './api-error';
-import { JETPACK_BOOST_REST_NAMESPACE, JETPACK_BOOST_REST_PREFIX } from './config';
-import type { JSONObject } from './utils/json-object-type';
-
-/**
- * Get the full URL to an endpoint.
- *
- * @param {string} path - The path to the endpoint.
- * @param {string} root - The root URL to use.
- * @returns {string} - The full URL.
- */
-function getEndpointUrl( path: string, root: string ): string {
-	return root + JETPACK_BOOST_REST_NAMESPACE + JETPACK_BOOST_REST_PREFIX + path;
-}
-
-/**
- * Send a request to the Boost REST API.
- *
- * @param {string} method - The HTTP method to use.
- * @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.
- */
-async function sendRequest(
-	method: string,
-	root: string,
-	path: string,
-	body: null | JSONObject = null,
-	nonce: string
-): Promise< Response > {
-	const args: JSONObject = {
-		method,
-		mode: 'cors',
-		headers: {
-			'X-WP-Nonce': nonce,
-		},
-	};
-
-	if ( ( 'post' === method || 'delete' === method ) && body ) {
-		args.body = JSON.stringify( body );
-		args.headers[ 'Content-Type' ] = 'application/json';
-	}
-
-	const endpointFullUrl = getEndpointUrl( path, root );
-	let apiCall: Response;
-
-	try {
-		apiCall = await fetch( endpointFullUrl, args );
-	} catch ( error ) {
-		const cleanupArgs = args;
-		delete cleanupArgs.body;
-		delete cleanupArgs.headers[ 'X-WP-Nonce' ];
-		const errorInfo = {
-			requestInitiator: window.location.href,
-			requestUrl: endpointFullUrl,
-			requestArgs: cleanupArgs,
-			originalErrorMessage: error.toString(),
-		};
-
-		// Throwing again an error so it can be caught higher up and displayed in the UI.
-		throw new Error(
-			sprintf(
-				/* Translators: %s refers to a string representation of an error object containing useful debug information  */
-				__(
-					'An error occurred while trying to communicate with the site REST API. Extra debug info: %s',
-					'boost-score-api'
-				),
-				JSON.stringify( errorInfo )
-			)
-		);
-	}
-
-	return apiCall;
-}
-
-/**
- * Make a request to the Boost REST API.
- *
- * @param {string} method - The HTTP method to use.
- * @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.
- */
-async function makeRequest< T = JSONObject >(
-	method: string,
-	root: string,
-	path: string,
-	body: null | JSONObject = null,
-	nonce: string
-): Promise< T > {
-	const response = await sendRequest( method, root, path, body, nonce );
-
-	// Fetch response as text.
-	let responseBody: string;
-	try {
-		responseBody = await response.text();
-	} catch ( err ) {
-		throw new ApiError( response.status, null, err );
-	}
-
-	// Try to parse it as JSON, catch errors explicitly.
-	let jsonBody: JSONObject;
-	try {
-		jsonBody = JSON.parse( responseBody );
-	} catch ( err ) {
-		throw new ApiError( response.status, responseBody, err );
-	}
-
-	// Throw an error if not HTTP 200.
-	if ( ! response.ok ) {
-		throw new ApiError( response.status, jsonBody, null );
-	}
-
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	return jsonBody as any;
-}
-
-/**
- * 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} nonce - The nonce to use.
- * @returns {Promise} - The response.
- */
-function get< T = JSONObject >( root: string, path: string, nonce: string ): Promise< T > {
-	return makeRequest< T >( 'get', root, path, null, nonce );
-}
-
-/**
- * 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.
- */
-function post< T = JSONObject >(
-	root: string,
-	path: string,
-	body: JSONObject | null = null,
-	nonce: string
-): Promise< T > {
-	return makeRequest< T >( 'post', root, path, body, nonce );
-}
-
-export default {
-	get,
-	post,
-};

package/src/config.ts

@@ -1,2 +0,0 @@
-export const JETPACK_BOOST_REST_NAMESPACE = 'jetpack-boost/v1';
-export const JETPACK_BOOST_REST_PREFIX = '';

package/src/index.ts

@@ -1,283 +0,0 @@
-import { __ } from '@wordpress/i18n';
-import api from './api';
-import { castToNumber } from './utils/cast-to-number';
-import { castToString } from './utils/cast-to-string';
-import { isJsonObject, JSONObject } from './utils/json-types';
-import pollPromise from './utils/poll-promise';
-import { standardizeError } from './utils/standardize-error';
-
-const pollTimeout = 2 * 60 * 1000;
-const pollInterval = 5 * 1000;
-
-type SpeedScores = {
-	mobile: number;
-	desktop: number;
-};
-
-type SpeedScoresSet = {
-	current: SpeedScores;
-	noBoost: SpeedScores;
-	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;
-};
-
-/**
- * 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.
- */
-export async function requestSpeedScores(
-	force = false,
-	rootUrl: string,
-	siteUrl: string,
-	nonce: string
-): Promise< SpeedScoresSet > {
-	// Request metrics
-	const response = parseResponse(
-		await api.post(
-			rootUrl,
-			force ? '/speed-scores/refresh' : '/speed-scores',
-			{ url: siteUrl },
-			nonce
-		)
-	);
-
-	// If the response contains ready-to-use metrics, we're done here.
-	if ( response.scores ) {
-		return response.scores;
-	}
-
-	// Poll for metrics.
-	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).
- *
- * @param {JSONObject} response - API response to parse
- * @returns {ParsedApiResponse} API response, processed.
- */
-function parseResponse( response: JSONObject ): ParsedApiResponse {
-	// Handle an explicit error
-	if ( response.error ) {
-		const defaultErrorMessage = __(
-			'An unknown error occurred while requesting metrics',
-			'boost-score-api'
-		);
-
-		throw standardizeError( response.error, defaultErrorMessage );
-	}
-
-	// Check if ready.
-	if ( isJsonObject( response.scores ) ) {
-		return {
-			status: 'success',
-			scores: {
-				current: isJsonObject( response.scores.current )
-					? {
-							mobile: castToNumber( response.scores.current.mobile, 0 ),
-							desktop: castToNumber( response.scores.current.desktop, 0 ),
-					  }
-					: {
-							mobile: 0,
-							desktop: 0,
-					  },
-				noBoost: isJsonObject( response.scores.noBoost )
-					? {
-							mobile: castToNumber( response.scores.noBoost.mobile, 0 ),
-							desktop: castToNumber( response.scores.noBoost.desktop, 0 ),
-					  }
-					: null,
-				isStale: !! response.scores.isStale,
-			},
-		};
-	}
-
-	const requestStatus = castToString( response.status );
-	if ( ! requestStatus ) {
-		throw new Error( __( 'Invalid response while requesting metrics', 'boost-score-api' ) );
-	}
-
-	return {
-		status: requestStatus,
-	};
-}
-
-/**
- * Poll a speed score request for results, timing out if it takes too long.
- *
- * @param {string} rootUrl - Root URL of the site to request metrics for
- * @param {string} siteUrl - Site URL to request metrics for
- * @param {string} nonce - Nonce to use for authentication
- * @returns {SpeedScoresSet} Speed scores returned by the server.
- */
-async function pollRequest(
-	rootUrl: string,
-	siteUrl: string,
-	nonce: string
-): Promise< SpeedScoresSet > {
-	return pollPromise< SpeedScoresSet >( {
-		timeout: pollTimeout,
-		interval: pollInterval,
-		timeoutError: __( 'Timed out while waiting for speed-score.', 'boost-score-api' ),
-		callback: async resolve => {
-			const response = parseResponse(
-				await api.post( rootUrl, '/speed-scores', { url: siteUrl }, nonce )
-			);
-
-			if ( response.scores ) {
-				resolve( response.scores );
-			}
-		},
-	} );
-}
-
-/**
- * Given a mobile and desktop score, return a letter summarizing the overall
- * score.
- *
- * @param {number} mobile  - Mobile speed score
- * @param {number} desktop - Desktop speed score
- * @returns {string} letter score
- */
-export function getScoreLetter( mobile: number, desktop: number ): string {
-	const sum = mobile + desktop;
-	const averageScore = sum / 2;
-
-	if ( averageScore > 90 ) {
-		return 'A';
-	}
-	if ( averageScore > 75 ) {
-		return 'B';
-	}
-	if ( averageScore > 50 ) {
-		return 'C';
-	}
-	if ( averageScore > 35 ) {
-		return 'D';
-	}
-	if ( averageScore > 25 ) {
-		return 'E';
-	}
-	return 'F';
-}
-
-/**
- * Find out if site scores changed. We fire a popout modal if they improve or worsen.
- * 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.
- */
-export function didScoresChange( scores: SpeedScoresSet ): boolean {
-	const current = scores.current;
-	const noBoost = scores.noBoost;
-
-	// lets make this a little bit more readable. If one of the scores is null.
-	// then the scores haven't changed. So return false.
-	if ( null == current || null == noBoost ) {
-		return false;
-	}
-
-	// if either the mobile or the desktop scores have changed. Return true.
-	if ( current.mobile !== noBoost.mobile || current.desktop !== noBoost.desktop ) {
-		return true;
-	}
-
-	//else if reach here then the scores are the same.
-	return false;
-}
-
-/**
- * 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.
- */
-export function getScoreMovementPercentage( scores: SpeedScoresSet ): number {
-	const current = scores.current;
-	const noBoost = scores.noBoost;
-	let currentScore = 0;
-	let noBoostScore = 0;
-
-	if ( current !== null && noBoost !== null ) {
-		currentScore = scores.current.mobile + scores.current.desktop;
-		noBoostScore = scores.noBoost.mobile + scores.noBoost.desktop;
-		const change = currentScore / noBoostScore - 1;
-		return Math.round( change * 100 );
-	}
-	return 0;
-}

package/src/utils/poll-promise.ts

@@ -1,52 +0,0 @@
-import { __ } from '@wordpress/i18n';
-
-type Resolve< RetType = void > = ( value: RetType | PromiseLike< RetType > ) => void;
-
-type PollPromiseArgs< RetType = void > = {
-	interval: number;
-	timeout: number;
-	timeoutError?: string;
-	callback: ( resolve: Resolve< RetType > ) => Promise< void > | void;
-};
-
-/**
- * Repeatedly poll callback every <interval> milliseconds until it calls the
- * resolve() callback. If the callback throws an error, the whole polling
- * promise will reject.
- *
- * Rejects with a timeout after <timeout> milliseconds.
- *
- * @template RetType
- * @param {object}   obj              - Arguments object.
- * @param {number}   obj.interval     - Milliseconds between calling callback
- * @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.
- */
-export default async function pollPromise< RetType = void >( {
-	interval,
-	callback,
-	timeout,
-	timeoutError,
-}: PollPromiseArgs< RetType > ): Promise< RetType > {
-	let timeoutHandle: ReturnType< typeof setTimeout >,
-		intervalHandle: ReturnType< typeof setInterval >;
-
-	return new Promise< RetType >( ( resolve, reject ) => {
-		timeoutHandle = setTimeout( () => {
-			reject( new Error( timeoutError || __( 'Timed out', 'boost-score-api' ) ) );
-		}, timeout || 2 * 60 * 1000 );
-
-		intervalHandle = setInterval( async () => {
-			try {
-				await Promise.resolve( callback( resolve ) );
-			} catch ( err ) {
-				reject( err );
-			}
-		}, interval );
-	} ).finally( () => {
-		clearTimeout( timeoutHandle );
-		clearInterval( intervalHandle );
-	} );
-}

package/src/utils/standardize-error.ts

@@ -1,33 +0,0 @@
-import type { JSONValue } from './json-types';
-
-/**
- * JavaScript offers no guarantee that caught objects in catch blocks are actually
- * Error objects. This method fixes that, for type safety. :)
- *
- * @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.
- */
-export function standardizeError( data: JSONValue | Error, defaultMessage?: string ): Error {
-	if ( data instanceof Error ) {
-		return data;
-	}
-
-	if ( typeof data === 'string' || data instanceof String ) {
-		return new Error( data.toString() );
-	}
-
-	// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-	// @ts-ignore
-	if ( data.message ) {
-		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-		// @ts-ignore
-		return new Error( data.message );
-	}
-
-	if ( defaultMessage ) {
-		return new Error( defaultMessage );
-	}
-
-	return new Error( JSON.stringify( data ) );
-}

package/webpack.config.cjs

@@ -1,34 +0,0 @@
-const path = require( 'path' );
-const jetpackWebpackConfig = require( '@automattic/jetpack-webpack-config/webpack' );
-
-module.exports = {
-	entry: './src/index.ts',
-	mode: jetpackWebpackConfig.mode,
-	devtool: jetpackWebpackConfig.isProduction ? false : 'source-map',
-	module: {
-		strictExportPresence: true,
-		rules: [
-			{
-				test: /\.ts?$/,
-				use: 'ts-loader',
-				exclude: /node_modules/,
-			},
-		],
-	},
-	optimization: {
-		...jetpackWebpackConfig.optimization,
-	},
-	resolve: {
-		...jetpackWebpackConfig.resolve,
-	},
-	output: {
-		...jetpackWebpackConfig.output,
-		path: path.resolve( __dirname, 'build' ),
-		filename: 'index.js',
-		library: {
-			name: 'BoostScoreApiLibrary',
-			type: 'umd',
-		},
-	},
-	plugins: [ ...jetpackWebpackConfig.StandardPlugins() ],
-};