@hashicorp/react-components 1.1.10 → 1.2.0

package/src/components/nav-panel/standard-panel/index.tsx

@@ -12,12 +12,14 @@ interface StandardPanelProps {
 	navData: NavItem[]
 	promo?: PromoProps
 	sectionName?: string
+	locale?: any
 }
 
 const StandardPanel = ({
 	navData,
 	promo,
 	sectionName = '',
+	locale,
 }: StandardPanelProps) => {
 	return (
 		<NavPanel.Root>
@@ -26,6 +28,7 @@ const StandardPanel = ({
 					return (
 						<NavPanel.Column key={stableIdx}>
 							<LinkList
+								locale={locale}
 								links={navItems}
 								linkClickHandler={(text, href) => {
 									trackNavClickEvent(text, href, sectionName)

package/src/components/nav-panel/standard-panel/style.module.css

@@ -1,8 +1,8 @@
 .columns {
 	display: flex;
-	gap: var(--hdsplus-spacing-03);
+	gap: var(--mds-spacing-03);
 	flex-direction: column;
-	margin-top: var(--hdsplus-spacing-07);
+	margin-top: var(--mds-spacing-07);
 
 	@media (--large) {
 		flex-direction: row;

package/src/lib/get-localized-link-props/index.test.ts

@@ -0,0 +1,30 @@
+import { getLocalizedLinkProps } from '.'
+
+describe('getLocalizedLinkProps', () => {
+	it('does not format localized homepage', () => {
+		const localizedLinkProps = getLocalizedLinkProps('/en', 'ja')
+		expect(localizedLinkProps.href).toBe('/en')
+		expect(localizedLinkProps.hrefLang).toBe('en')
+	})
+
+	it('does not format localized path hrefs', () => {
+		const localizedLinkProps = getLocalizedLinkProps('/ja/solutions', 'de')
+		expect(localizedLinkProps.href).toBe('/ja/solutions')
+		expect(localizedLinkProps.hrefLang).toBe('ja')
+	})
+
+	it('does format paths that start with a locale string', () => {
+		const localizedLinkProps = getLocalizedLinkProps(
+			'/deconstructing-cloud',
+			'en',
+		)
+		expect(localizedLinkProps.href).toBe('/en/deconstructing-cloud')
+		expect(localizedLinkProps.hrefLang).toBe('en')
+	})
+
+	it('does not format external paths', () => {
+		const localizedLinkProps = getLocalizedLinkProps('https://google.com', 'ja')
+		expect(localizedLinkProps.href).toBe('https://google.com')
+		expect(localizedLinkProps.hrefLang).toBe(undefined)
+	})
+})

package/src/lib/get-localized-link-props/index.ts

@@ -0,0 +1,45 @@
+import { parseUrl } from '../parse-url'
+import { allSupportedLocales } from '../supported-locales'
+
+export const getLocalizedLinkProps = (
+	url: string,
+	locale?: string,
+): {
+	href: string
+	hrefLang: string | undefined
+} => {
+	const parsedHref = parseUrl(url).href
+
+	// example: /en
+	const hrefIsLocalizedHomepage = allSupportedLocales.includes(
+		parsedHref.substring(1),
+	)
+
+	// true example: /en/solutions
+	// false example: /entry-point
+	const hrefIsLocalized =
+		allSupportedLocales.includes(parsedHref.substring(1, 3)) &&
+		parsedHref[3] === '/'
+
+	// If the href is already localized:
+	// - do not format the href
+	// - use the locale from the href for the hrefLang
+	if (hrefIsLocalizedHomepage || hrefIsLocalized) {
+		return {
+			href: parsedHref,
+			hrefLang: parsedHref.substring(1, 3),
+		}
+	}
+
+	if (parsedHref.startsWith('/') && locale) {
+		return {
+			href: `/${locale}${parsedHref}`,
+			hrefLang: locale,
+		}
+	}
+
+	return {
+		href: parsedHref,
+		hrefLang: undefined,
+	}
+}

package/src/lib/parse-url/index.test.ts

@@ -1,4 +1,4 @@
-import { parseUrl } from '.'
+import { parseUrl, hasHashiCorpDestination } from '.'
 
 describe('parseUrl', () => {
 	it('detects hashicorp.com URLs as internal', () => {
@@ -7,6 +7,12 @@ describe('parseUrl', () => {
 		expect(url.linkType).toBe('inbound')
 	})
 
+	it('detects www.hashicorp.com URLs as internal', () => {
+		const url = parseUrl('https://hashicorp.com/foo')
+		expect(url.href).toBe('/foo')
+		expect(url.linkType).toBe('inbound')
+	})
+
 	it('detects URLs not containing hashicorp.com as external', () => {
 		const externalUrl = 'https://google.com/example'
 		const url = parseUrl(externalUrl)
@@ -23,8 +29,57 @@ describe('parseUrl', () => {
 
 	it('leaves URL search params intact', () => {
 		const url = parseUrl(
-			'https://hashicorp.com/resources?type=case-study&products=terraform'
+			'https://hashicorp.com/resources?type=case-study&products=terraform',
 		)
 		expect(url.href).toBe('/resources?type=case-study&products=terraform')
 	})
+
+	it('leaves URL hash intact', () => {
+		const url = parseUrl('https://hashicorp.com/about#leadership')
+		expect(url.href).toBe('/about#leadership')
+	})
+
+	it('leaves HashiCorp subdomain URLs intact', () => {
+		const url = parseUrl('https://developer.hashicorp.com/terraform')
+		expect(url.href).toBe('https://developer.hashicorp.com/terraform')
+	})
+
+	it('detects not allowed schemes', () => {
+		const url = parseUrl('ftp://hashicorp.com/example')
+		expect(url.linkType).toBe('')
+		expect(url.href).toBe('')
+	})
+
+	it('returns mailto links', () => {
+		const mailtoUrl = parseUrl('mailto:example@hashicorp.com')
+		expect(mailtoUrl.href).toBe('mailto:example@hashicorp.com')
+	})
+
+	it('returns tel links', () => {
+		const telUrl = parseUrl('tel:+1234567890')
+		expect(telUrl.href).toBe('tel:+1234567890')
+	})
+})
+
+describe('hasHashiCorpDestination', () => {
+	it('returns true for supported hashicorp domains', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination(
+			'https://portal.cloud.hashicorp.com/foo',
+		)
+		expect(isHashiCorpDestination).toBe(true)
+	})
+	it('returns false for external domains', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination(
+			'https://foo.com/bar',
+		)
+		expect(isHashiCorpDestination).toBe(false)
+	})
+	it('returns true for relative links', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination('/bar')
+		expect(isHashiCorpDestination).toBe(true)
+	})
+	it('returns true for hashes', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination('#someHash')
+		expect(isHashiCorpDestination).toBe(true)
+	})
 })

package/src/lib/parse-url/index.ts

@@ -1,32 +1,116 @@
+export const hashicorpDestinations: string[] = [
+	'app.terraform.io',
+	'boundaryproject.io',
+	'cloud.hashicorp.com',
+	'consul.io',
+	'developer.hashicorp.com',
+	'hashicorp.com',
+	'nomadproject.io',
+	'packer.io',
+	'portal.cloud.hashicorp.com',
+	'registry.terraform.io',
+	'terraform.io',
+	'vagrantup.com',
+	'vaultproject.io',
+	'waypointproject.io',
+] as const
+
+const containsHashiCorpDestination = (str: string): boolean =>
+	hashicorpDestinations.some(function (destination) {
+		return str.indexOf(destination) >= 0
+	})
+
+/**
+ * This function determines if a `url` is a HashiCorp link (relative URLs, hashes,
+ * or a url with a HashiCorp domain) or a  non-HashiCorp link.
+ *
+ * @param {string | undefined} url - The URL to be parsed. It may be a relative URL, an anchor, or a full external/internal URL.
+ *
+ * @returns {{ linkType: 'inbound' | 'outbound', href: string }}
+ *   An object with two properties:
+ *     - `linkType`: Indicates whether the URL is 'inbound' or 'outbound'. Can be used to conditionally
+ * 		     render the value of the target attribute.
+ *     - `href`: The parsed href (may include pathname, search, and hash for internal URLs).
+ *
+ * @throws {Error} Throws an error if the URL is undefined or invalid.
+ */
 export function parseUrl(url: string | undefined): {
-	linkType: 'inbound' | 'outbound'
+	linkType: 'inbound' | 'outbound' | ''
 	href: string
 } {
 	if (!url) {
-		throw new Error('url is required')
+		return { linkType: '', href: '' }
 	}
 
+	// Allow safe relative paths and in-page anchors as-is.
 	if (isRelative(url) || isAnchor(url)) {
 		return { linkType: 'inbound', href: url }
 	}
 
-	if (isInternal(url)) {
-		try {
-			const { pathname, search } = new URL(url)
-			const href = pathname + search
+	// For absolute URLs, ensure they use an allowed scheme and then classify as internal/outbound.
+	try {
+		const parsed = new URL(url)
+
+		if (!isAllowedScheme(parsed.protocol)) {
+			console.log(`Disallowed URL scheme in href: ${url}`)
+			return { linkType: '', href: '' }
+		}
+
+		if (isInternal(url)) {
+			const { pathname, search, hash } = parsed
+			const href = pathname + search + hash
 			return { linkType: 'inbound', href }
-		} catch (error) {
-			throw new Error(`Invalid href: ${url}`)
 		}
+
+		// Outbound but still using an allowed scheme.
+		return { linkType: 'outbound', href: url }
+	} catch (error) {
+		console.log(`Invalid href: ${url}`)
+		return { linkType: '', href: '' }
 	}
+}
+
+const isRelative = (url: string) => url.startsWith('/')
+const isAnchor = (url: string) => url.startsWith('#')
 
-	return { linkType: 'outbound', href: url }
+/**
+ * Determines whether the provided url uses hashicorp.com or www.hashicorp.com as the hostname.
+ *
+ * @param {string} url - The URL to check.
+ * @returns {boolean} - Returns true if the link uses a HashiCorp domain, otherwise false.
+ * Returns true if the given protocol string is an allowed URL scheme for links.
+ * Only http and https are allowed to prevent injection of javascript:, data:, etc.
+ */
+const ALLOWED_SCHEMES = ['http:', 'https:', 'mailto:', 'tel:']
+const isAllowedScheme = (protocol: string): boolean => {
+	return ALLOWED_SCHEMES.includes(protocol)
 }
 
-const isRelative = (url) => url.startsWith('/')
-const isAnchor = (url) => url.startsWith('#')
+/**
+ */
 
-export const isInternal = (url) => {
+export const isInternal = (url: string): boolean => {
 	const hostname = new URL(url).hostname
-	return hostname === 'hashicorp.com'
+	return hostname === 'hashicorp.com' || hostname === 'www.hashicorp.com'
+}
+
+/**
+ * Determines whether the provided url uses a HashiCorp hostname. This is used in several
+ * components to open a new tab for non-HashiCorp links.
+ *
+ * @param {string} url - The URL to check.
+ * @returns {boolean} - Returns true if the link uses a HashiCorp domain, otherwise false.
+ */
+
+export const hasHashiCorpDestination = (url: string): boolean => {
+	// Fast return in case a relative URL or anchor is passed in
+	if (isRelative(url) || isAnchor(url)) return true
+	try {
+		const hostname = new URL(url).hostname
+		const isHashiCorpDestination = containsHashiCorpDestination(hostname)
+		return isHashiCorpDestination
+	} catch (e) {
+		console.error('Error: `url` is not a valid URL', e)
+		return false
+	}
 }

package/src/lib/send-posthog-event/index.ts

@@ -0,0 +1,22 @@
+import posthog from 'posthog-js'
+
+/**
+ * A custom hook to send a custom event to PostHog.
+ *
+ * @param {string} eventName - The name of the custom event to be tracked in PostHog.
+ * @param {Record<string, any>} properties - A key-value object containing properties associated with the event.
+ *
+ * @example
+ * const MyComponent = () => {
+ *   sendPosthogEvent('button_click', { buttonId: 'submit', action: 'clicked' });
+ *   return <button id="submit">Submit</button>;
+ * };
+ */
+const sendPosthogEvent = (
+	eventName: string,
+	properties: Record<string, any>,
+) => {
+	posthog.capture(eventName, properties)
+}
+
+export default sendPosthogEvent

package/src/lib/supported-locales/index.ts

@@ -0,0 +1,10 @@
+export const allSupportedLocales = [
+	'en',
+	'de',
+	'es',
+	'fr',
+	'ja',
+	'ko',
+	'pt',
+	'id',
+]

package/src/lib/track-nav-click-event/index.ts

@@ -1,8 +1,8 @@
-import va from '@vercel/analytics'
+import sendPosthogEvent from '../send-posthog-event'
 
 /**
- * Pushes a 'Nav link click' custom event to Vercel Analytics.
- * A wrapper around the Vercel Analytics track method.
+ * Pushes a 'Nav link click' custom event to PostHog.
+ * A wrapper around the PostHog custom event method.
  *
  * @param {string} name - The name of the nav link
  * @param {string} href - The href for the nav link
@@ -12,9 +12,9 @@ import va from '@vercel/analytics'
 export const trackNavClickEvent = (
 	name: string,
 	href: string,
-	section: string
+	section?: string,
 ) => {
-	va.track('Nav link click', {
+	sendPosthogEvent('Nav link click', {
 		name,
 		href,
 		section,

package/src/lib/v/index.ts

@@ -3,9 +3,14 @@ import { vercelStegaSplit } from '@vercel/stega'
 /**
  * Takes in a Vercel Visual Editing string and returns the string without
  * hidden data.
+ *
  */
-export function v<VercelVEString extends string>(
-	s: VercelVEString
-): VercelVEString {
-	return vercelStegaSplit(s).cleaned as VercelVEString
+export const vercelSplit = <VercelString>(
+	original: VercelString,
+): VercelString => {
+	if (typeof original === 'string') {
+		return vercelStegaSplit(original).cleaned as VercelString
+	} else {
+		return original
+	}
 }

package/tsconfig.json

@@ -9,6 +9,5 @@
 		],
 		"types": ["vitest/globals", "@testing-library/jest-dom"]
 	},
-	"include": ["./**/*"],
-	"exclude": ["node_modules"]
+	"include": ["./**/*"]
 }

package/.eslintrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: require.resolve('@hashicorp/platform-cli/config/.eslintrc.js'),
-}

package/.stylelintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@hashicorp/platform-cli/config/stylelint.config']
-}

package/src/components/actions/index.tsx

@@ -1,107 +0,0 @@
-/**
- * Copyright (c) HashiCorp, Inc.
- * SPDX-License-Identifier: MPL-2.0
- */
-
-import classNames from 'classnames'
-import Button from '@hashicorp/react-design-system-components/src/components/button'
-import StandaloneLink from '@hashicorp/react-design-system-components/src/components/standalone-link'
-import { IconArrowRight16 } from '@hashicorp/flight-icons/svg-react/arrow-right-16'
-import { IconArrowRight24 } from '@hashicorp/flight-icons/svg-react/arrow-right-24'
-import type { ActionsProps } from './types'
-import s from './style.module.css'
-import { ComponentProps } from 'react'
-
-const hasButton = (item) => item.type === 'button' || item.type === undefined
-const hasStandaloneLink = (item) => item.type === 'standalone-link'
-
-export default function Actions({
-	appearance = 'light',
-	layout = 'inline',
-	alignment = 'left',
-	theme = 'primary',
-	size = 'large',
-	ctas,
-}: ActionsProps) {
-	if (ctas.length < 1 || ctas.length > 2) {
-		throw new Error(
-			`Actions expects at least 1 cta, no more than 2. You provided ${ctas.length}.`
-		)
-	}
-	let mixed = false
-	// If CTAs contain a button and standalone link
-	// increase the column gap
-	if (ctas.some(hasButton) && ctas.some(hasStandaloneLink)) {
-		mixed = true
-	}
-	return (
-		<div
-			className={classNames(
-				s.actions,
-				s[layout],
-				s[alignment],
-				mixed && s.mixed
-			)}
-			data-testid="actions"
-		>
-			{ctas.map((cta, index) => {
-				// The first CTA and second CTA should always
-				// have the `primary` and `secondary` variations respectively.
-
-				const standaloneLinkVariant: ComponentProps<
-					typeof StandaloneLink
-				>['color'] =
-					index === 0
-						? 'primary'
-						: appearance === 'dark'
-						? 'secondary-inverted'
-						: 'secondary'
-				const isStandaloneLink = cta?.type === 'standalone-link'
-
-				if (isStandaloneLink) {
-					return (
-						<StandaloneLink
-							// eslint-disable-next-line react/no-array-index-key
-							key={index}
-							text={cta.title}
-							icon={
-								size === 'large' ? (
-									<IconArrowRight24
-										width="100%"
-										height="100%"
-										style={{ display: 'block' }}
-									/>
-								) : (
-									<IconArrowRight16
-										width="100%"
-										height="100%"
-										style={{ display: 'block' }}
-									/>
-								)
-							}
-							iconPosition="trailing"
-							href={cta.href}
-							color={standaloneLinkVariant}
-							size={size}
-							onClick={cta?.onClick}
-							data-testid={`standaloneLink-${index}`}
-						/>
-					)
-				} else {
-					return (
-						<Button
-							// eslint-disable-next-line react/no-array-index-key
-							key={index}
-							text={cta.title}
-							href={cta.href}
-							onClick={cta.onClick}
-							size={size}
-							color={theme}
-							data-testid={`button-${index}`}
-						/>
-					)
-				}
-			})}
-		</div>
-	)
-}

package/src/components/actions/style.module.css

@@ -1,28 +0,0 @@
-/**
- * Copyright (c) HashiCorp, Inc.
- * SPDX-License-Identifier: MPL-2.0
- */
-
-.actions {
-	display: flex;
-	align-items: center;
-	flex-wrap: wrap;
-	gap: 16px 18px;
-
-	&.stacked {
-		flex-direction: column;
-
-		&.left {
-			align-items: flex-start;
-		}
-
-		&.center {
-			align-items: center;
-		}
-	}
-
-	&.mixed {
-		column-gap: 24px;
-		row-gap: 32px;
-	}
-}

package/src/components/actions/types.ts

@@ -1,73 +0,0 @@
-/**
- * Copyright (c) HashiCorp, Inc.
- * SPDX-License-Identifier: MPL-2.0
- */
-
-import type { Products } from '@hashicorp/platform-product-meta'
-
-interface CtaProps {
-	/**
-	 * The text that appears inside the button.
-	 */
-	title: string
-	/**
-	 * Where the button links to when clicked.
-	 */
-	href: string
-	/**
-	 * A function that will be called when the button is clicked.
-	 */
-	onClick?: () => void
-}
-
-interface ButtonCtaProps extends CtaProps {
-	type?: 'button'
-}
-
-interface StandaloneLinkCtaProps extends CtaProps {
-	type: 'standalone-link'
-}
-
-export interface ActionsProps {
-	/**
-	 * Display actions on light or dark background.
-	 */
-	appearance?: 'light' | 'dark'
-	/**
-	 * Display buttons inline or stacked by default.
-	 */
-	layout?: 'inline' | 'stacked'
-	/**
-	 * Display buttons inline or stacked by default.
-	 */
-	alignment?: 'left' | 'center'
-	/**
-	 * Render primary button with product color.
-	 */
-	theme?:
-		| 'primary'
-		| 'secondary'
-		| 'secondary-high-contrast'
-		| 'tertiary'
-		| 'critical'
-		| Exclude<Products, 'hashicorp'>
-	/**
-	 * Determines CTA button sizing.
-	 */
-	size?: 'small' | 'medium' | 'large'
-	/**
-	 * Array of CTAs. Minimum of one, max of two.
-	 * When both a Button and StandaloneLink are
-	 * rendered, they can only render in said order.
-	 * This is intentional and ensures adherence to a design
-	 * requirement of rendering the Button first when data
-	 * for both a Button and a StandaloneLink are provided.
-	 * @see CtaProps
-	 */
-	ctas:
-		| [ButtonCtaProps]
-		| [StandaloneLinkCtaProps]
-		| [ButtonCtaProps, ButtonCtaProps]
-		| [StandaloneLinkCtaProps, StandaloneLinkCtaProps]
-		| [ButtonCtaProps, StandaloneLinkCtaProps]
-}