@hashicorp/react-components 0.0.0-nightly.a80dc5e → 0.0.0-nightly.a830c6d

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

@@ -1,9 +1,47 @@
+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')
+		console.log('No url to parse, returning empty string')
+		return { linkType: '', href: '' }
 	}
 
 	if (isRelative(url) || isAnchor(url)) {
@@ -12,21 +50,50 @@ export function parseUrl(url: string | undefined): {
 
 	if (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/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;
-	}
-}

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

@@ -1,194 +0,0 @@
-import { render, screen } from '@testing-library/react'
-import ConsentPreferences from './dialog'
-
-beforeAll(() => {
-	HTMLDialogElement.prototype.show = vi.fn()
-	HTMLDialogElement.prototype.showModal = vi.fn()
-	HTMLDialogElement.prototype.close = vi.fn()
-})
-
-const defaultProps = {
-	segmentWriteKey: 'iyi06c432UL7SB1r3fQReec4bNwFyzkW',
-	privacyPolicyLink: 'https://www.hashicorp.com/privacy',
-	segmentServices: [
-		{
-			name: 'Example Name',
-			category: 'Example Category',
-			description:
-				'A short description of what the service is and how your company uses the data.',
-		},
-	],
-	additionalServices: [
-		{
-			name: 'Name of the service',
-			category: 'Example Category',
-			description:
-				'A short description of what the service is and how your company uses the data.',
-			body: '',
-			url: 'http://www.an-optional-url-for-a-script-to-add-to-the-page.com',
-			async: true,
-		},
-		{
-			name: 'Name of the service 2',
-			category: 'Example Category',
-			description: 'A script with additional elements to be injected',
-			body: '',
-			url: 'https://source-url-of-script.com',
-			async: true,
-			addToBody: true,
-			dataAttrs: [
-				{
-					name: 'test',
-					value: 'foobar',
-				},
-			],
-		},
-		{
-			name: 'Name of the service 3',
-			category: 'Example Category',
-			description: 'A script with additional elements to be injected',
-			body: 'window.foo = "bar"',
-			async: true,
-			dataAttrs: [
-				{
-					name: 'test',
-					value: 'foobar',
-				},
-			],
-		},
-		{
-			name: 'Name of the conditionally loaded service',
-			category: 'Example Category with conditionally loaded service',
-			description: 'A script with additional elements to be injected',
-			body: 'window.foo = "bar"',
-			url: 'https://source-of-conditionally-loaded-script.com',
-			async: true,
-			dataAttrs: [
-				{
-					name: 'test',
-					value: 'foobar',
-				},
-			],
-			shouldLoad: () => false,
-		},
-	],
-	categories: [
-		{
-			name: 'Example Category',
-			description: 'A short description of the category',
-		},
-		{
-			name: 'Another Example Category',
-			description: 'A short description of the category',
-		},
-	],
-	preferences: { loadAll: true },
-	saveAndLoadAnalytics: () => null,
-	showDialog: false,
-}
-
-test('segmentServices`, `additionalServices`, and `segmentWriteKey` props are passed to getIntegration function', async () => {
-	const getIntegrationsModule = await import('../../util/integrations')
-	const getIntegrations = vi.spyOn(getIntegrationsModule, 'default')
-
-	render(<ConsentPreferences {...defaultProps} />)
-	const { segmentServices, additionalServices, segmentWriteKey } = defaultProps
-	expect(getIntegrations).toHaveBeenCalledWith(
-		segmentServices,
-		additionalServices,
-		segmentWriteKey
-	)
-})
-
-test('custom `privacyPolicyLink` renders in the right place', () => {
-	render(<ConsentPreferences {...defaultProps} />)
-	expect(screen.getByTestId('privacy-policy-link')).toHaveAttribute(
-		'href',
-		defaultProps.privacyPolicyLink
-	)
-})
-
-test.todo('Displays the correct categories with their descriptions', () => {
-	const testValue = 'test'
-	render(<ConsentPreferences {...defaultProps} />)
-	expect(screen.getByTestId('privacy-policy-link')).toHaveAttribute(
-		'href',
-		testValue
-	)
-})
-
-test('Dialog closes and opens based on props', () => {
-	vi.spyOn(HTMLDialogElement.prototype, 'showModal')
-
-	const { rerender } = render(<ConsentPreferences {...defaultProps} />)
-	rerender(<ConsentPreferences {...defaultProps} showDialog={true} />)
-	expect(HTMLDialogElement.prototype.showModal).toHaveBeenCalled()
-})
-
-test.todo(
-	'Toggles are populated correctly according to the `preferences` props'
-)
-
-test.todo(
-	'When "see more" within a category is clicked, it will toggle and expand/contract it\'s items'
-)
-
-test.todo(
-	'Displays the correct items within each category with their descriptions'
-)
-
-test.todo(
-	'When the toggle for a category is clicked, all items in that category are turned on or off'
-)
-
-test.todo(
-	'When the toggle for a item within a category is clicked, that item is turned on or off'
-)
-
-test.todo(
-	'Category toggle displays as active if one of its items are active, inactive only if all items are inactive'
-)
-
-test.todo(
-	'dialog hides and `saveAndLoadAnalytics` is called when the "Save Preferences" button is clicked'
-)
-
-test.todo(
-	'clicking "X" in top right corner displays the cancellation confirmation dialog and hides the main dialog'
-)
-
-test.todo(
-	'clicking "Cancel" at the bottom displays the cancellation confirmation dialog and hides the manage preferences dialog'
-)
-
-test.todo(
-	'within the cancellation confirmation dialog, clicking "Back to Preferences" hides the cancellation confirmation dialog and brings back the manage preferences dialog'
-)
-
-test.todo(
-	'within the cancellation confirmation dialog, clicking "Agree and Close" calls `saveAndLoadAnalytics` and closes the dialog'
-)
-
-test.todo(
-	'when the "Agree and Close" button is clicked, `saveAndLoadAnalytics` runs and the dialog is closed'
-)
-
-// 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()
-// })