@hashicorp/react-components 0.0.0-nightly.8df4a87 → 0.0.0-nightly.91abcef

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

@@ -0,0 +1,69 @@
+import { parseUrl, hasHashiCorpDestination } from '.'
+
+describe('parseUrl', () => {
+	it('detects hashicorp.com URLs as internal', () => {
+		const url = parseUrl('https://hashicorp.com/example')
+		expect(url.href).toBe('/example')
+		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)
+		expect(url.href).toBe(externalUrl)
+		expect(url.linkType).toBe('outbound')
+	})
+
+	it('detects relative URLs as internal', () => {
+		const relativeUrl = '/resources'
+		const url = parseUrl(relativeUrl)
+		expect(url.href).toBe(relativeUrl)
+		expect(url.linkType).toBe('inbound')
+	})
+
+	it('leaves URL search params intact', () => {
+		const url = parseUrl(
+			'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')
+	})
+})
+
+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

@@ -0,0 +1,104 @@
+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) {
+		console.log('No url to parse, returning empty string')
+		return { linkType: '', href: '' }
+	}
+
+	if (isRelative(url) || isAnchor(url)) {
+		return { linkType: 'inbound', href: url }
+	}
+
+	if (!forceExternal && isInternal(url)) {
+		try {
+			const { pathname, search, hash } = new URL(url)
+			const href = pathname + search + hash
+			return { linkType: 'inbound', href }
+		} catch (error) {
+			console.log(`Invalid href: ${url}`)
+			return { linkType: '', href: '' }
+		}
+	}
+
+	return { linkType: 'outbound', href: url }
+}
+
+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: string): boolean => {
+	const hostname = new URL(url).hostname
+	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/track-nav-click-event/index.ts

@@ -0,0 +1,22 @@
+import va from '@vercel/analytics'
+
+/**
+ * Pushes a 'Nav link click' custom event to Vercel Analytics.
+ * A wrapper around the Vercel Analytics track method.
+ *
+ * @param {string} name - The name of the nav link
+ * @param {string} href - The href for the nav link
+ * @param {string} [section] - The name of the section of the nav. Top-level links do not have a section.
+ */
+
+export const trackNavClickEvent = (
+	name: string,
+	href: string,
+	section: string
+) => {
+	va.track('Nav link click', {
+		name,
+		href,
+		section,
+	})
+}

package/src/lib/v/index.ts

@@ -0,0 +1,10 @@
+import { vercelStegaSplit } from '@vercel/stega'
+
+/**
+ * Takes in a Vercel Visual Editing string and returns the string without
+ * hidden data.
+ *
+ */
+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()
-})

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

@@ -1,73 +0,0 @@
-import Link from 'next/link'
-import Button from '@hashicorp/react-design-system-components/src/components/button'
-import ButtonSet from '@hashicorp/react-design-system-components/src/components/button-set'
-import Text from '@hashicorp/react-design-system-components/src/components/text'
-import s from './banner.module.css'
-
-interface ConsentBannerProps {
-	preferences?: { loadAll?: boolean }
-	privacyPolicyLink?: string
-	cookiePolicyLink?: string
-	onManagePreferences?: () => void
-	onAccept?: () => void
-}
-
-export default function ConsentBanner({
-	preferences,
-	privacyPolicyLink,
-	cookiePolicyLink,
-	onManagePreferences,
-	onAccept,
-}: ConsentBannerProps) {
-	return (
-		<div className={s.root} data-testid="consent-banner">
-			<div className={s.innerContainer}>
-				<Text.Body color="primary">
-					We use cookies & other similar technology to collect data to improve
-					your experience on our site, as described in our{' '}
-					<Link
-						href={
-							privacyPolicyLink ?? 'https://www.hashicorp.com/trust/privacy'
-						}
-						className={s.link}
-						target="_blank"
-						rel="noopener noreferrer"
-						data-testid="privacy-policy"
-					>
-						Privacy Policy
-					</Link>{' '}
-					and{' '}
-					<Link
-						href={
-							cookiePolicyLink ??
-							'https://www.hashicorp.com/trust/privacy/cookies'
-						}
-						className={s.link}
-						target="_blank"
-						rel="noopener noreferrer"
-						data-testid="cookie-policy"
-					>
-						Cookie Policy
-					</Link>
-					.
-				</Text.Body>
-				<div>
-					<ButtonSet>
-						<Button
-							onClick={onManagePreferences}
-							color="secondary"
-							data-testid="manage-preferences"
-							text="Manage Preferences"
-						/>
-						<Button
-							onClick={onAccept}
-							color="primary"
-							data-testid="accept"
-							text={preferences?.loadAll ? 'Dismiss' : 'Accept'}
-						/>
-					</ButtonSet>
-				</div>
-			</div>
-		</div>
-	)
-}

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

@@ -1,145 +0,0 @@
-.root {
-	position: fixed;
-	top: 0;
-	left: 0;
-	width: 100%;
-	height: 100%;
-	display: flex;
-	justify-content: center;
-	align-items: center;
-	z-index: 999;
-	background-color: rgba(0, 0, 0, 0.5);
-	border: 0;
-}
-
-.flexCenteredRow {
-	display: flex;
-	justify-content: space-between;
-	align-items: center;
-}
-
-.visibleDialog {
-	display: flex;
-	flex-direction: column;
-	width: 60%;
-	max-width: 734px;
-	background-color: var(--token-color-surface-primary);
-	color: var(--black);
-	border-radius: var(--hdsplus-spacing-03);
-	overflow: hidden; /* IE */
-	max-height: 80%;
-	box-shadow: var(--token-surface-overlay-box-shadow);
-
-	@media (max-width: 1000px) {
-		width: 85%;
-	}
-
-	@media (max-width: 700px) {
-		width: 90%;
-	}
-}
-
-.dialogHeader {
-	display: flex;
-	justify-content: space-between;
-	align-items: center;
-	background-color: var(--token-color-surface-faint);
-	border-bottom: 1px solid var(--token-color-border-primary);
-	padding: var(--hdsplus-spacing-07);
-	flex-shrink: 0;
-}
-
-.dialogBody {
-	padding: var(--hdsplus-spacing-07);
-	flex-grow: 1;
-	overflow-y: scroll;
-	display: flex;
-	flex-direction: column;
-	gap: var(--hdsplus-spacing-05);
-}
-
-.category {
-	border-top: 1px solid var(--token-color-foreground-faint);
-}
-
-.categoryHeader {
-	display: flex;
-	align-items: center;
-	gap: var(--hdsplus-spacing-05);
-	padding: var(--hdsplus-spacing-07) 0;
-}
-
-.categoryFoldTrigger {
-	--size: 24px;
-	--svg-rotation: 0 deg;
-
-	appearance: none;
-	margin: 0;
-	margin-left: auto;
-	padding: 0;
-	width: var(--size);
-	height: var(--size);
-	display: grid;
-	place-items: center;
-	border: 0;
-	background-color: transparent;
-	cursor: pointer;
-	color: var(--token-color-foreground-strong);
-
-	& svg {
-		transform: rotate(var(--svg-rotation));
-		transition: transform 0.3s;
-	}
-
-	&.shown {
-		--svg-rotation: 180deg;
-	}
-}
-
-.categoryFold {
-	margin-top: -16px;
-	padding-bottom: var(--hdsplus-spacing-07);
-}
-
-.categoryFoldDescription {
-	composes: g-type-body-small from global;
-	margin: 0;
-	color: var(--wpl-neutral-500);
-}
-
-.categoryItem {
-	display: flex;
-	flex-direction: column;
-	margin-top: var(--hdsplus-spacing-05);
-	padding: var(--hdsplus-spacing-05);
-}
-
-.categoryItemHeader {
-	display: flex;
-	align-items: center;
-	gap: var(--hdsplus-spacing-05);
-}
-
-.categoryItemTitle {
-	margin: 0;
-}
-
-.categoryItemDescription {
-	margin: var(--hdsplus-spacing-02) 0 0;
-}
-
-.dialogFooter {
-	display: flex;
-	flex-direction: column;
-	justify-content: flex-end;
-	flex-shrink: 0;
-	padding: var(--hdsplus-spacing-07);
-	column-gap: var(--hdsplus-spacing-07);
-	row-gap: var(--hdsplus-spacing-04);
-	background-color: var(--token-color-surface-faint);
-	border-top: 1px solid var(--token-color-border-primary);
-
-	@media (min-width: 420px) {
-		flex-direction: row;
-	}
-}