@hashicorp/react-components 0.0.0-canary.0299c5d

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,98 @@
+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' | ''
+	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 (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/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 @@
+export const allSupportedLocales = ['en', 'de', 'es', 'fr', 'ja', 'ko', 'pt']

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

@@ -0,0 +1,22 @@
+import sendPosthogEvent from '../send-posthog-event'
+
+/**
+ * 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
+ * @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
+) => {
+	sendPosthogEvent('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/tsconfig.json

@@ -0,0 +1,14 @@
+{
+	"extends": "../../base.tsconfig.json",
+	"compilerOptions": {
+		"baseUrl": ".",
+		"plugins": [
+			{
+				"name": "next"
+			}
+		],
+		"types": ["vitest/globals", "@testing-library/jest-dom"]
+	},
+	"include": ["./**/*"],
+	"exclude": ["node_modules"]
+}

package/vitest.config.mts

@@ -0,0 +1,12 @@
+import { defineConfig, configDefaults } from 'vitest/config'
+import react from '@vitejs/plugin-react'
+
+export default defineConfig({
+	plugins: [react()],
+	test: {
+		globals: true,
+		environment: 'jsdom',
+		exclude: [...configDefaults.exclude, 'src/__tests__/e2e'],
+		setupFiles: ['.test/setup-vitest.js'],
+	},
+})