@automattic/jetpack-boost-score-api 0.1.0

package/.gitattributes

@@ -0,0 +1,16 @@
+# 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/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+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.0 - 2023-05-29
+### Added
+- Create package for the boost score bar API [#30781]

package/LICENSE.txt

@@ -0,0 +1,357 @@
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+===================================
+
+
+GNU GENERAL PUBLIC LICENSE
+   Version 2, June 1991
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+		Preamble
+
+The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+GNU GENERAL PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+a) You must cause the modified files to carry prominent notices
+stating that you changed the files and the date of any change.
+
+b) You must cause any work that you distribute or publish, that in
+whole or in part contains or is derived from the Program or any
+part thereof, to be licensed as a whole at no charge to all third
+parties under the terms of this License.
+
+c) If the modified program normally reads commands interactively
+when run, you must cause it, when started running for such
+interactive use in the most ordinary way, to print or display an
+announcement including an appropriate copyright notice and a
+notice that there is no warranty (or else, saying that you provide
+a warranty) and that users may redistribute the program under
+these conditions, and telling the user how to view a copy of this
+License.  (Exception: if the Program itself is interactive but
+does not normally print such an announcement, your work based on
+the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+a) Accompany it with the complete corresponding machine-readable
+source code, which must be distributed under the terms of Sections
+1 and 2 above on a medium customarily used for software interchange; or,
+
+b) Accompany it with a written offer, valid for at least three
+years, to give any third party, for a charge no more than your
+cost of physically performing source distribution, a complete
+machine-readable copy of the corresponding source code, to be
+distributed under the terms of Sections 1 and 2 above on a medium
+customarily used for software interchange; or,
+
+c) Accompany it with the information you received as to the offer
+to distribute corresponding source code.  (This alternative is
+allowed only for noncommercial distribution and only if you
+received the program in object code or executable form with such
+an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+		NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) <year>  <name of author>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+Gnomovision version 69, Copyright (C) year name of author
+Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+This is free software, and you are welcome to redistribute it
+under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+`Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+<signature of Ty Coon>, 1 April 1989
+Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

package/README.md

@@ -0,0 +1,20 @@
+# boost-score-api
+
+A package to get the Jetpack Boost score of a site
+
+## How to install boost-score-api
+
+Add `"@automattic/jetpack-boost-score-api": "workspace:*",` to your project's `package.json` and run `pnpm install` (or `yarn` if your project uses yarn)
+
+## Using this package in your WordPress plugin
+
+If you plan on using this package in your WordPress plugin, we would recommend that you use [Jetpack Autoloader](https://packagist.org/packages/automattic/jetpack-autoloader) as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.
+
+## Security
+
+Need to report a security vulnerability? Go to [https://automattic.com/security/](https://automattic.com/security/) or directly to our security bug bounty site [https://hackerone.com/automattic](https://hackerone.com/automattic).
+
+## License
+
+boost-score-api is licensed under [GNU General Public License v2 (or later)](./LICENSE.txt)
+

package/SECURITY.md

@@ -0,0 +1,38 @@
+# Security Policy
+
+Full details of the Automattic Security Policy can be found on [automattic.com](https://automattic.com/security/).
+
+## Supported Versions
+
+Generally, only the latest version of Jetpack has continued support. If a critical vulnerability is found in the current version of Jetpack, we may opt to backport any patches to previous versions. 
+
+## Reporting a Vulnerability
+
+[Jetpack](https://jetpack.com/) is an open-source plugin for WordPress. Our HackerOne program covers the plugin software, as well as a variety of related projects and infrastructure.
+
+**For responsible disclosure of security issues and to be eligible for our bug bounty program, please submit your report via the [HackerOne](https://hackerone.com/automattic) portal.**
+
+Our most critical targets are:
+
+* Jetpack and the Jetpack composer packages (all within this repo)
+* Jetpack.com -- the primary marketing site.
+* cloud.jetpack.com -- a management site.
+* wordpress.com -- the shared management site for both Jetpack and WordPress.com sites.
+
+For more targets, see the `In Scope` section on [HackerOne](https://hackerone.com/automattic).
+
+_Please note that the **WordPress software is a separate entity** from Automattic. Please report vulnerabilities for WordPress through [the WordPress Foundation's HackerOne page](https://hackerone.com/wordpress)._
+
+## Guidelines
+
+We're committed to working with security researchers to resolve the vulnerabilities they discover. You can help us by following these guidelines:
+
+*   Follow [HackerOne's disclosure guidelines](https://www.hackerone.com/disclosure-guidelines).
+*   Pen-testing Production:
+    *   Please **setup a local environment** instead whenever possible. Most of our code is open source (see above).
+    *   If that's not possible, **limit any data access/modification** to the bare minimum necessary to reproduce a PoC.
+    *   **_Don't_ automate form submissions!** That's very annoying for us, because it adds extra work for the volunteers who manage those systems, and reduces the signal/noise ratio in our communication channels.
+    *   To be eligible for a bounty, all of these guidelines must be followed.
+*   Be Patient - Give us a reasonable time to correct the issue before you disclose the vulnerability.
+
+We also expect you to comply with all applicable laws. You're responsible to pay any taxes associated with your bounties.

package/babel.config.cjs

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

package/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "@automattic/jetpack-boost-score-api",
+	"version": "0.1.0",
+	"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": {
+		"url": "https://github.com/Automattic/jetpack/labels/[JS Package] Boost Score Api"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/Automattic/jetpack.git",
+		"directory": "projects/js-packages/boost-score-api"
+	},
+	"license": "GPL-2.0-or-later",
+	"author": "Automattic",
+	"scripts": {
+		"build": "pnpm run clean && webpack",
+		"clean": "rm -rf build/",
+		"watch": "pnpm run build && pnpm webpack watch",
+		"test": "jest tests"
+	},
+	"dependencies": {
+		"@wordpress/i18n": "4.32.0",
+		"zod": "3.20.2"
+	},
+	"devDependencies": {
+		"@automattic/jetpack-webpack-config": "workspace:*",
+		"@typescript-eslint/parser": "5.59.0",
+		"eslint": "8.39.0",
+		"jest": "29.5.0",
+		"ts-loader": "9.4.2",
+		"typescript": "5.0.4",
+		"webpack": "5.76.0",
+		"webpack-cli": "4.9.1"
+	},
+	"exports": {
+		".": {
+			"types": "./build/index.d.ts",
+			"default": "./build/index.js"
+		}
+	},
+	"main": "./build/index.js",
+	"types": "./build/index.d.ts"
+}

package/src/api-error.ts

@@ -0,0 +1,65 @@
+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

@@ -0,0 +1,156 @@
+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

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

package/src/index.ts

@@ -0,0 +1,220 @@
+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;
+};
+
+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 );
+}
+
+/**
+ * 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/cast-to-number.ts

@@ -0,0 +1,27 @@
+/**
+ * Given an unknown value from an external source (e.g.: API response), parse
+ * it as a number. Returns defaultValue if the value does not seem to be a valid
+ * number.
+ *
+ * @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.
+ */
+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;
+}

package/src/utils/cast-to-string.ts

@@ -0,0 +1,28 @@
+/**
+ * Given an unknown value from an external source (e.g.: API response), parse
+ * it as a string. Returns defaultValue if the value does not seem to be a valid
+ * string.
+ *
+ * @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.
+ */
+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;
+}

package/src/utils/json-object-type.ts

@@ -0,0 +1,12 @@
+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 >;
+export type JSONValue = Literal | JSONObject | JSONValue[];
+export type JSONObject = { [ key: string ]: JSONValue };

package/src/utils/json-types.ts

@@ -0,0 +1,32 @@
+/* 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;
+};
+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 );
+}
+
+/**
+ * Returns true if the given JSONValue is a JSONArray.
+ * 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.
+ */
+export function isJsonArray( value: JSONValue ): value is JSONArray {
+	return value instanceof Array;
+}

package/src/utils/poll-promise.ts

@@ -0,0 +1,51 @@
+import { __ } from '@wordpress/i18n';
+
+type Resolve< ReturnType = void > = ( value: ReturnType | PromiseLike< ReturnType > ) => void;
+
+type PollPromiseArgs< ReturnType = void > = {
+	interval: number;
+	timeout: number;
+	timeoutError?: string;
+	callback: ( resolve: Resolve< ReturnType > ) => 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 ReturnType
+ * @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< ReturnType >} - A promise which resolves to the value resolved() inside callback.
+ */
+export default async function pollPromise< ReturnType = void >( {
+	interval,
+	callback,
+	timeout,
+	timeoutError,
+}: PollPromiseArgs< ReturnType > ): Promise< ReturnType > {
+	let timeoutHandle: number, intervalHandle: number;
+
+	return new Promise< ReturnType >( ( 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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,34 @@
+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() ],
+};