@hashicorp/react-components 0.0.0-nightly.48bfabb → 0.0.0-nightly.52c0d39

package/src/components/subnav/partials/MenuItemsOverflow/index.tsx

@@ -4,7 +4,7 @@
  */
 
 import React from 'react'
-import { v } from '../../../../lib/v'
+import { vercelSplit } from '../../../../lib/v'
 import Link from 'next/link'
 import type { Products } from '@hashicorp/platform-product-meta'
 import CtaLinks, { type CtaLinkProps } from '../CtaLinks'
@@ -12,6 +12,8 @@ import DropdownTrigger from '../DropdownTrigger'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import classNames from 'classnames'
 import s from './style.module.css'
+import FlightIcon from '@hashicorp/react-hds/src/components/flight-icon'
+import { getLocalizedLinkProps } from '../../../../lib/get-localized-link-props'
 
 interface MenuItemsOverflowProps {
 	menuItems: (
@@ -19,7 +21,7 @@ interface MenuItemsOverflowProps {
 		| {
 				text: string
 				url: string
-				submenu: { url: string; text: string }[]
+				submenu: { icon: string; url: string; text: string }[]
 		  }
 	)[]
 	ctaLinks: CtaLinkProps
@@ -28,6 +30,7 @@ interface MenuItemsOverflowProps {
 	menuText: string
 	constrainWidth?: boolean
 	activatePanel: (panel: string) => void
+	locale?: string
 }
 
 interface MenuItemsOverflowState {
@@ -47,6 +50,7 @@ class MenuItemsOverflow extends React.Component<
 			menuText,
 			constrainWidth,
 			activatePanel,
+			locale,
 		} = this.props
 
 		const handleFocusOutside = () => {
@@ -89,6 +93,9 @@ class MenuItemsOverflow extends React.Component<
 													key={subStableIdx}
 													url={subItem.url}
 													text={subItem.text}
+													icon={subItem.icon}
+													locale={locale}
+													product={product}
 												/>
 											))}
 											<hr className={s.divider} />
@@ -101,6 +108,7 @@ class MenuItemsOverflow extends React.Component<
 											key={stableIdx}
 											url={url}
 											text={text}
+											product={product}
 										/>
 									)
 								}
@@ -120,15 +128,23 @@ class MenuItemsOverflow extends React.Component<
 }
 
 interface SubmenuItemProps {
+	icon?: string
 	url: string
 	text: string
+	locale?: string
+	product?: string
 }
 
-function SubmenuItem({ url, text }: SubmenuItemProps) {
+function SubmenuItem({ icon, url, text, locale, product }: SubmenuItemProps) {
 	return (
 		<li>
 			<NavigationMenu.Link asChild>
-				<Link className={s.submenuItem} href={url} title={v(text)}>
+				<Link
+					className={s.submenuItem}
+					title={vercelSplit(text)}
+					{...getLocalizedLinkProps(url, locale, Boolean(product))}
+				>
+					{icon ? <FlightIcon name={icon} /> : null}
 					{text}
 				</Link>
 			</NavigationMenu.Link>

package/src/components/subnav/partials/MenuItemsOverflow/style.module.css

@@ -3,8 +3,6 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/* Note: consumes from theme.module.css, as marked */
-
 .root {
 	position: relative;
 	display: flex;
@@ -12,14 +10,14 @@
 }
 
 .dropdown {
-	background: var(--dropdown-background-color); /* from theme.module.css */
-	border-radius: 4px;
+	background: var(--token-color-surface-primary);
+	border-radius: var(--hdsplus-spacing-03);
 	box-shadow: var(--token-elevation-high-box-shadow);
-	border: 1px solid var(--border-color);
+	border: 1px solid var(--token-color-border-primary);
 	margin-top: 8px;
 	max-height: calc(100vh - 300%);
 	overflow-y: auto;
-	padding: var(--hdsplus-spacing-04) var(--hdsplus-spacing-07);
+	padding: var(--hdsplus-spacing-04);
 	position: absolute;
 	right: 0;
 	top: 100%;
@@ -52,27 +50,35 @@
 
 .submenuTitle {
 	composes: g-type-label from global;
-	margin: 12px 0 8px 0;
-	color: var(--menu-item-heading-text-color); /* from theme.module.css */
+	margin: var(--hdsplus-spacing-04) var(--hdsplus-spacing-03) 8px;
+	color: var(--token-color-foreground-faint);
 }
 
 .divider {
-	margin: 12px 0;
+	margin: var(--hdsplus-spacing-04) var(--hdsplus-spacing-03);
 	border: 0;
 	padding: 0;
 	height: 1px;
-	background: var(--border-color); /* from theme.module.css */
+	background: var(--token-color-border-primary);
 }
 
 .submenuItem {
-	display: block;
-	padding: 4px 0;
-	color: var(--menu-item-text-color); /* from theme.module.css */
-	font-weight: var(--font-weight-semi-bold);
-	font-size: var(--token-typography-body-300-font-size);
+	composes: hds-typography-body-300 from global;
+	composes: hds-font-weight-semibold from global;
+	display: flex;
+	gap: var(--hdsplus-spacing-04);
+	padding: var(--hdsplus-spacing-02) var(--hdsplus-spacing-03);
+	color: var(--token-color-foreground-primary);
+	border-radius: var(--hdsplus-spacing-01);
+	align-items: center;
 
 	&:hover {
-		text-decoration: underline;
+		background-color: var(--token-color-surface-interactive-hover);
+	}
+
+	&:focus {
+		outline: 2px solid var(--token-color-focus-action-internal);
+		outline-style: auto;
 	}
 }
 

package/src/components/subnav/partials/TitleLink/index.tsx

@@ -7,7 +7,7 @@ import { forwardRef } from 'react'
 import { camelCase } from 'camel-case'
 import Link from 'next/link'
 import Image from 'next/image'
-import { v } from '../../../../lib/v'
+import { vercelSplit } from '../../../../lib/v'
 import classNames from 'classnames'
 import * as CommunityProductLogosOnDark from './mktg-logos/all-community-product-logos_on-dark'
 import * as CommunityProductLogosOnLight from './mktg-logos/all-community-product-logos_on-light'
@@ -22,6 +22,7 @@ import WaypointLogoAttrOnDark from '@hashicorp/web-mktg-logos/src/waypoint/hashi
 import HCPTerraformLogoOnLight from '@hashicorp/web-mktg-logos/src/terraform/hcp-terraform/hcp-terraform_on-light.svg'
 import HCPTerraformLogoOnDark from '@hashicorp/web-mktg-logos/src/terraform/hcp-terraform/hcp-terraform_on-dark.svg'
 import s from './style.module.css'
+import { getLocalizedLinkProps } from '../../../../lib/get-localized-link-props'
 
 const logoDict = {
 	light: {
@@ -41,6 +42,7 @@ const logoDict = {
 }
 
 interface TitleLinkProps {
+	locale?: string
 	text: string
 	url: string
 	product?: string
@@ -80,8 +82,8 @@ function getLogo(
 }
 
 const TitleLink = forwardRef<HTMLAnchorElement, TitleLinkProps>(
-	({ text, url, product, theme }, ref) => {
-		const parsedText = v(text)
+	({ text, url, product, theme, locale }, ref) => {
+		const parsedText = vercelSplit(text)
 		const Logo = getLogo(parsedText, theme)
 
 		return (
@@ -91,9 +93,9 @@ const TitleLink = forwardRef<HTMLAnchorElement, TitleLinkProps>(
 					s[`brand-${product}`],
 					s[camelCase(parsedText)]
 				)}
-				href={url}
 				title={parsedText}
 				ref={ref}
+				{...getLocalizedLinkProps(url, locale)}
 			>
 				{Logo ? (
 					<Image

package/src/components/subnav/partials/TitleLink/style.module.css

@@ -10,7 +10,7 @@
 	display: inline-flex;
 	padding-block: var(--hdsplus-spacing-04);
 	font-weight: var(--font-weight-bold);
-	color: var(--title-text-color); /* from theme.module.css */
+	color: var(--token-color-foreground-primary); /* from theme.module.css */
 	font-size: 1.25rem;
 	line-height: 1.35rem;
 

package/src/components/subnav/partials/nav-item-text/style.module.css

@@ -3,13 +3,11 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/* Note: consumes from theme.module.css, as marked */
-
 .root {
-	color: var(--menu-item-text-color); /* from theme.module.css */
+	color: var(--token-color-foreground-primary);
 	position: relative;
 
 	&.isActive {
-		color: var(--menu-item-text-color-active);
+		color: var(--token-color-foreground-strong);
 	}
 }

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

@@ -3,19 +3,17 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/* Note: consumes from theme.module.css, as marked */
-
 .root {
 	position: sticky;
 	top: -1px;
 	z-index: 900;
-	background: var(--background-color); /* from theme.module.css */
-	border-top: 1px solid var(--border-color); /* from theme.module.css */
+	background: var(--token-color-surface-primary);
+	border-top: 1px solid var(--token-color-border-faint);
 	border-bottom: 1px solid transparent;
 	transition: border-bottom-color 0.8s;
 
 	&.isSticky {
-		border-bottom-color: var(--border-color); /* from theme.module.css */
+		border-bottom-color: var(--token-color-border-faint);
 	}
 
 	/*
@@ -46,7 +44,7 @@
 
 .subnavInner {
 	display: grid;
-	grid-template-columns: minmax(max-content, 1fr) min-content;
+	grid-template-columns: max-content min-content;
 	align-items: center;
 	justify-content: space-between;
 	min-height: 62px;

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,46 @@
+import { parseUrl } from '../parse-url'
+import { allSupportedLocales } from '../supported-locales'
+
+export const getLocalizedLinkProps = (
+	url: string,
+	locale?: string,
+	forceExternal?: boolean
+): {
+	href: string
+	hrefLang: string | undefined
+} => {
+	const parsedHref = parseUrl(url, forceExternal).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)
@@ -27,4 +33,37 @@ describe('parseUrl', () => {
 		)
 		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')
+	})
+})
+
+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,104 @@
-export function parseUrl(url: string | undefined): {
-	linkType: 'inbound' | 'outbound'
+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.
+ */
+
+// @TODO: delete forceExternal when io sites are shutdown
+
+export function parseUrl(
+	url: string | undefined,
+	forceExternal?: boolean
+): {
+	linkType: 'inbound' | 'outbound' | ''
 	href: string
 } {
 	if (!url) {
-		throw new Error('url is required')
+		console.log('No url to parse, returning empty string')
+		return { linkType: '', href: '' }
 	}
 
 	if (isRelative(url) || isAnchor(url)) {
 		return { linkType: 'inbound', href: url }
 	}
 
-	if (isInternal(url)) {
+	if (!forceExternal && isInternal(url)) {
 		try {
-			const { pathname, search } = new URL(url)
-			const href = pathname + search
+			const { pathname, search, hash } = new URL(url)
+			const href = pathname + search + hash
 			return { linkType: 'inbound', href }
 		} catch (error) {
-			throw new Error(`Invalid href: ${url}`)
+			console.log(`Invalid href: ${url}`)
+			return { linkType: '', href: '' }
 		}
 	}
 
 	return { linkType: 'outbound', href: url }
 }
 
-const isRelative = (url) => url.startsWith('/')
-const isAnchor = (url) => url.startsWith('#')
+const isRelative = (url: string) => url.startsWith('/')
+const isAnchor = (url: string) => url.startsWith('#')
+
+/**
+ * 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.
+ */
 
-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/supported-locales/index.ts

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

package/src/lib/v/index.ts

@@ -3,9 +3,8 @@ 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 => vercelStegaSplit(original as string).cleaned as VercelString

package/src/components/consent-manager/README.md

@@ -1,73 +0,0 @@
-# Consent Manager
-
-A GDPR-compliant consent manager.
-
-### Props
-
-- `version` (integer) - version number, bump up to override previous consent preferences
-- `container` (string) - id of container where the consent manager should live
-- `companyName` (string) - your company name to be inserted in various copy
-- `privacyPolicyLink` (string) - link to your company's privacy policy
-- `segmentWriteKey` (string) - your production segment write key
-- `segmentServices` (array of objects) - use this to override the category or description of a service provided by Segment
-  - `name` - name of the Segment integration, must match the integration you are overriding
-  - `category` _[optional]_ - new category name
-  - `description` _[optional]_ - new description
-- `categories` (array) - State of toggle
-  - `name` - name of category
-  - `description` - description for the category
-- `additionalServices` (array of objects) - additional integrations outside of Segment that you wish to include in the consent manager
-  - `name` - name of service
-  - `description` - description of service
-  - `category` - category of service
-  - `body` _[optional]_ - javascript body associated with service _If present, overrides `url` below_
-  - `url` _[optional]_ - url of js file associated with service
-  - `async` (bool) _[optional]_ - add `async` property to script element
-  - `addToBody` (bool) _[optional]_ - inject script before closing `<body>` tag
-  - `dataAttrs` (arr) _[optional]_ - array of `data-` attributes to add to script tag
-    - `name` (str) - name of data attribute (`data-name`)
-    - `value` (str) - value of `data` attribute to set
-- `showDialog` (bool) - whether or not the dialog `open` attribute is true
-
-
-## `SegmentPreloadScript`
-
-In `v9.0.0`, ConsentManager now exports a `SegmentPreloadScript` component. Why? ConsentManager uses a very similar Segment script to the current preloading script that we use in our `_document.tsx/js` files.
-
-Now that we're updating both with a custom Segment AJS URL and CDN hostname, it makes sense for the two to be co-located.
-
-Expect the new change to look like the following:
-
-```diff
-// pages/_document.tsx
-
-
-  import Document, { Html, Head, Main, NextScript } from 'next/document'
-  import HashiHead from '@hashicorp/react-head'
-+ import { SegmentPreloadScript } from '@web/react-components/src/components/consent-manager/scripts/segment'
-  // other imports
-
-  export default class MyDocument extends Document {
-    static async getInitialProps(ctx) {
-      const initialProps = await Document.getInitialProps(ctx)
-      return { ...initialProps }
-    }
-
-    render() {
-      return (
-        <Html lang="en">
-          <Head>
-            <HashiHead />
-          </Head>
-          <body>
--           <script
--             dangerouslySetInnerHTML={{
--               __html: `!function(){var analytics=window... ... ...`
--             }}
--           />
-+           <SegmentPreloadScript />
-
-// etc...
-```
-
-No additional updates are necessary!

package/src/components/consent-manager/components/banner/banner.module.css

@@ -1,23 +0,0 @@
-.root {
-	background-color: var(--token-color-surface-strong);
-	width: 100%;
-	padding: 10px 15px;
-	position: fixed;
-	bottom: 0;
-	left: 0;
-	z-index: 10;
-	font-size: 0.9rem;
-}
-
-.innerContainer {
-	composes: g-grid-container from global;
-	display: flex;
-	justify-content: space-between;
-	align-items: center;
-	gap: var(--hdsplus-spacing-01);
-	flex-direction: column;
-
-	@media (min-width: 1350px) {
-		flex-direction: row;
-	}
-}

package/src/components/consent-manager/components/banner/banner.test.tsx

@@ -1,31 +0,0 @@
-import { render, screen, fireEvent } from '@testing-library/react'
-import ConsentBanner from './banner'
-
-test('should display the correct privacy policy url', () => {
-	const testValue = 'test'
-	render(<ConsentBanner privacyPolicyLink={testValue} />)
-	expect(screen.getByTestId('privacy-policy')).toHaveAttribute(
-		'href',
-		testValue
-	)
-})
-
-test('should display the correct cookie policy url', () => {
-	const testValue = 'test'
-	render(<ConsentBanner cookiePolicyLink={testValue} />)
-	expect(screen.getByTestId('cookie-policy')).toHaveAttribute('href', testValue)
-})
-
-test('should run the onManagePreferences function when the correct button is clicked', () => {
-	const mock = vi.fn()
-	render(<ConsentBanner onManagePreferences={mock} />)
-	fireEvent.click(screen.getByTestId('manage-preferences'))
-	expect(mock).toHaveBeenCalled()
-})
-
-test('should run the onAccept function when the correct button is clicked', () => {
-	const mock = vi.fn()
-	render(<ConsentBanner onAccept={mock} />)
-	fireEvent.click(screen.getByTestId('accept'))
-	expect(mock).toHaveBeenCalled()
-})