@automattic/calypso-url/src/get-calypso-url.ts

This library provides both generic and Calypso-specific utilities for handling URLs.

/**
 * These are the known places that Calypso is allowed to run.
 * Note that https://wordpress.com is not included as it's the default.
 */
const ALLOWED_ORIGINS = [
	'https://horizon.wordpress.com',
	'https://wpcalypso.wordpress.com',
	'http://calypso.localhost:3000',
	'https://calypso.localhost:3000',
];

/**
 * Checks if the origin is allowed by checking against ALLOWED_ORIGINS and Calypso Live sites.
 *
 * @param origin string to check
 * @returns true if the origin is allowed
 */
function isAllowedOrigin( origin: string ) {
	return ALLOWED_ORIGINS.includes( origin ) || isCalypsoLive( origin );
}

/**
 * Checks if the origin is a Calypso Live site (e.g. https://busy-badger.calypso.live)
 *
 * @param origin string to check
 * @returns true if the origin is a Calypso Live site
 */
function isCalypsoLive( origin: string ) {
	return origin.match( /^https:\/\/[a-z0-9-]+\.calypso\.live$/ );
}

/**
 * From wp-admin contexts: gets the Calypso origin from the `wpcom_origin` query arg
 * and compares it against a list of allowed wpcom origins. Helps to maintain consistent
 * interlinking in Calypso dev/testing contexts.
 *
 * @param path Optional path to append to the origin
 * @returns The origin if it's allowed, otherwise the default origin (wordpress.com)
 */
export function getCalypsoUrl( path = '' ) {
	const defaultOrigin = 'https://wordpress.com';
	const fromQueryArg = new URLSearchParams( window.location.search ).get( 'calypso_origin' ) || '';
	let origin = defaultOrigin;

	if ( isAllowedOrigin( fromQueryArg ) ) {
		origin = fromQueryArg;
	}

	if ( path.length ) {
		// remove beginning slash from path if present
		path = path.replace( /^\//, '' );
		origin = `${ origin }/${ path }`;
	}

	return origin;
}