@hashicorp/react-components 0.0.0-nightly.f535c63 → 0.0.0-nightly.fbc9c8e

package/src/components/consent-manager/util/cookies.test.ts

@@ -1,75 +0,0 @@
-import cookies from 'js-cookie'
-import * as cookiesJS from './cookies.js'
-
-it('should not show preferences loaded before cookies are saved', () => {
-	expect(cookiesJS.preferencesSavedAndLoaded()).toBe(false)
-})
-
-it('should show preferences loaded if cookies are loaded', () => {
-	const preferences = JSON.stringify({ loadAll: true, version: 1 })
-	const originalCookiesGet = cookies.get
-
-	// mocks
-	cookies.get = vi.fn().mockImplementationOnce(() => preferences)
-	cookiesJS.loadPreferences()
-
-	const preferencesLoaded = cookiesJS.preferencesSavedAndLoaded()
-	expect(preferencesLoaded).toBe(true)
-
-	cookies.get = originalCookiesGet
-})
-
-it('should get the domain', () => {
-	const originalLocation = global.window.location
-	const originalCookiesGet = cookies.get
-	const originalCookiesSet = cookies.set
-
-	// mocks
-	delete global.window.location
-	global.window.location = { hostname: 'foo.bar.baz.net' }
-	cookies.get = vi.fn().mockImplementationOnce(() => 'baz.net')
-	cookies.set = vi.fn()
-
-	expect(cookiesJS.getDomain()).toBe('baz.net')
-
-	// restore mocks
-	global.window.location = originalLocation
-	cookies.get = originalCookiesGet
-	cookies.set = originalCookiesSet
-})
-
-it('should load preferences', () => {
-	const preferences = { loadAll: true, version: 1 }
-	const originalCookiesGet = cookies.get
-
-	// mocks
-	cookies.get = vi.fn().mockImplementationOnce(() => preferences)
-
-	expect(cookiesJS.loadPreferences()).toStrictEqual(preferences)
-
-	// restore mocks
-	cookies.get = originalCookiesGet
-})
-
-it('should save preferences', () => {
-	global.window.location = { hostname: 'foo.bar.baz.net' }
-	const preferences = { loadAll: true, version: 1 }
-	const version = 1
-	const args = [
-		cookiesJS.COOKIE_KEY,
-		JSON.stringify(preferences),
-		{ expires: cookiesJS.COOKIE_EXPIRES, domain: '' },
-	]
-	const originalCookiesSet = cookies.set
-
-	// mocks
-	cookies.set = vi.fn()
-
-	cookiesJS.savePreferences(preferences, version)
-
-	const lastArgs = cookies.set.mock.calls[cookies.set.mock.calls.length - 1]
-
-	expect(lastArgs).toStrictEqual(args)
-
-	cookies.set = originalCookiesSet
-})

package/src/components/consent-manager/util/cookies.ts

@@ -1,70 +0,0 @@
-/*
-  Cookies structure:
-  {
-    { segment: { Hotjar: true, Intercom: false, .. } },
-    { custom: { OptinMonster: true } },
-    { categories: { Functional: true } }
-  }
-*/
-
-import cookies from 'js-cookie'
-export const COOKIE_KEY = 'hashi-consent-preferences'
-export const COOKIE_EXPIRES = 183
-
-let preferences = undefined
-let preferencesLoaded = false
-
-export function getDomain() {
-	const host = window.location.hostname
-	const parts = host.split('.')
-	const levels: string[] = []
-	let result = ''
-
-	// get all domain levels
-	for (let i = parts.length - 2; i >= 0; i--) {
-		levels.push(parts.slice(i).join('.'))
-	}
-
-	// find top level domain
-	for (let i = 0; i < levels.length; i++) {
-		const cname = '__tld__'
-		const domain = levels[i]
-		const opts = { domain: '.' + domain }
-
-		cookies.set(cname, '1', opts)
-		if (cookies.get(cname)) {
-			cookies.set(cname, 'null', opts)
-			result = domain
-			break
-		}
-	}
-
-	return result
-}
-
-export const loadPreferences = () => {
-	if (!preferences) {
-		const value = cookies.get(COOKIE_KEY)
-		if (value && value !== {}.toString()) {
-			preferences = JSON.parse(value)
-			if (preferences) {
-				preferencesLoaded = true
-			}
-		}
-	}
-
-	return preferences
-}
-
-export function savePreferences(prefs, version) {
-	const domain = getDomain()
-	const prefsWithVersion = Object.assign(prefs, { version: version })
-	cookies.set(COOKIE_KEY, JSON.stringify(prefsWithVersion), {
-		expires: COOKIE_EXPIRES,
-		domain,
-	})
-	preferences = prefsWithVersion
-	preferencesLoaded = true
-}
-
-export const preferencesSavedAndLoaded = () => preferencesLoaded

package/src/components/consent-manager/util/integrations.test.ts

@@ -1,115 +0,0 @@
-test('fetches integrations from segment, formats them as expected', async () => {
-	vi.resetModules()
-	global.fetch = () =>
-		Promise.resolve({
-			ok: true,
-			json: () => mockSegmentResponse,
-		}) as any
-	const getIntegrations = await import('./integrations')
-	const resp = await getIntegrations.default(
-		mockProps.segmentServices,
-		mockProps.additionalServices,
-		'XXX - segment key'
-	)
-	expect(resp['Test Category'][0].name).toBe('Test Non-Segment Service')
-	expect(resp['Test Category'][0].origin).toBe('custom')
-	expect(resp['Test Category'][1].name).toBe('Test Non-Segment Service 2')
-	expect(resp['Test Category'][1].origin).toBe('custom')
-	expect(resp['Test Category'][2].name).toBe('Google Analytics')
-	expect(resp['Test Category'][2].origin).toBe('segment')
-	expect(resp['Test Category'][3].name).toBe('LinkedIn Insight Tag')
-	expect(resp['Test Category'][3].origin).toBe('segment')
-	expect(resp['Email Marketing'][0].name).toBe('Marketo V2')
-	expect(resp['Email Marketing'][0].origin).toBe('segment')
-})
-
-const mockSegmentResponse = [
-	{
-		name: 'Google Analytics',
-		creationName: 'Google Analytics',
-		description:
-			'Google Analytics is the most popular analytics tool for the web. It’s free and provides a wide range of features. It’s especially good at measuring traffic sources and ad campaigns.',
-		website: 'http://google.com/analytics',
-		category: 'Test Category',
-	},
-	{
-		name: 'LinkedIn Insight Tag',
-		creationName: 'LinkedIn Insight Tag',
-		description:
-			'The LinkedIn Insight Tag is a piece of lightweight JavaScript code that you can add to your website to enable in-depth campaign reporting and unlock valuable insights about your website visitors. As a LinkedIn Marketing Solutions customer, you can use the LinkedIn Insight Tag to track conversions, retarget website visitors, and unlock additional insights about members interacting with your ads.',
-		website: 'https://www.linkedin.com',
-		category: 'Advertising',
-	},
-	{
-		name: 'Marketo V2',
-		creationName: 'Marketo V2',
-		description:
-			'Marketo is a marketing automation tool that can help you engage customers and prospects.',
-		website: 'https://www.marketo.com/',
-		category: 'Email Marketing',
-	},
-	{
-		name: 'Heap',
-		creationName: 'Heap',
-		description:
-			'Heap is an analytics tool that automatically tracks all of the actions your users perform just by flipping a switch, instead of after adding custom tracking code.',
-		website: 'http://heapanalytics.com',
-		category: 'Analytics',
-	},
-	{
-		name: 'Google Tag Manager',
-		creationName: 'Google Tag Manager',
-		description:
-			'Google Tag Manager lets you add or update your website tags, easily and for free.',
-		website: 'https://www.google.com/analytics/tag-manager/',
-		category: 'Tag Managers',
-	},
-	{
-		name: 'Amazon S3',
-		creationName: 'Amazon S3',
-		description:
-			'Our Amazon S3 copies our log files of your raw API calls from our S3 bucket to yours, where you can then perform custom analysis on them.',
-		website: 'http://aws.amazon.com/s3',
-		category: 'Analytics',
-	},
-]
-
-const mockProps = {
-	segmentServices: [
-		{
-			name: 'LinkedIn Insight Tag',
-			category: 'Test Category',
-			description: 'description',
-		},
-	],
-	additionalServices: [
-		{
-			name: 'Test Non-Segment Service',
-			category: 'Test Category',
-			description: 'description',
-			body: 'test body',
-			url: 'test url',
-		},
-		{
-			name: 'Test Non-Segment Service 2',
-			category: 'Test Category',
-			description: 'description',
-			body: 'test body 2',
-			url: 'test url 2',
-			async: true,
-			addToBody: true,
-			dataAttrs: [
-				{
-					name: 'test',
-					value: 'foobar',
-				},
-			],
-		},
-	],
-	categories: [
-		{
-			name: 'Test Category',
-			description: 'description',
-		},
-	],
-}

package/src/components/consent-manager/util/integrations.ts

@@ -1,110 +0,0 @@
-import type { ConsentManagerService } from '../types'
-
-/*
-  integrations.js
-  Fetches integrations from Segment given write key and applies user-defined
-  overrides. Combines with custom scripts to give a complete view into
-  scripts that the site is trying to load. Finally, groups it all by category.
-*/
-
-export type ConsentManagerServiceWithOrigin = ConsentManagerService & {
-	origin: string
-}
-
-export default function getIntegrations(
-	segmentServices: ConsentManagerService[] = [],
-	additionalServices: ConsentManagerService[] = [],
-	segmentWriteKey: string | undefined
-): Promise<Record<string, ConsentManagerServiceWithOrigin[]>> {
-	return fetchIntegrationsFromSegment(segmentWriteKey)
-		.then((segmentOriginated) =>
-			zipIntegrations(segmentServices, additionalServices, segmentOriginated)
-		)
-		.then(groupByCategory)
-}
-
-interface SegmentIntegration {
-	name: string
-	creationName: string
-	description: string
-	website: string
-	category: string
-}
-
-// Get integrations from Segment by write key
-async function fetchIntegrationsFromSegment(
-	segmentWriteKey: string | undefined
-) {
-	const res = await fetch(
-		`https://artemis.hashicorp.com/v1/projects/${segmentWriteKey}/integrations`
-	)
-	if (!res.ok) {
-		throw new Error(
-			`Failed to fetch integrations: HTTP ${res.status} ${res.statusText}`
-		)
-	}
-	return (await res.json()) as SegmentIntegration[]
-}
-
-// Include developer overrides for fetched Segment integrations
-function zipIntegrations(
-	segmentOverrides: ConsentManagerService[],
-	additionalServices: ConsentManagerService[] | undefined,
-	segmentOriginated: SegmentIntegration[]
-): ConsentManagerServiceWithOrigin[] {
-	// Create Segment integration object with name as key for quick retrieval
-	const segmentObj = segmentOriginated.reduce((obj, segment) => {
-		obj[segment.name] = segment
-		obj[segment.name].origin = 'segment'
-		return obj
-	}, {})
-
-	// Go through each developer-defined segment service and update
-	// segmentObj with any overrides
-	for (let i = 0; i < segmentOverrides.length; i++) {
-		if (
-			Object.prototype.hasOwnProperty.call(segmentObj, segmentOverrides[i].name)
-		) {
-			segmentObj[segmentOverrides[i].name] = Object.assign(
-				segmentObj[segmentOverrides[i].name],
-				segmentOverrides[i]
-			)
-		} else {
-			/* eslint-disable-next-line */
-			console.warn(
-				`Unmatched integration config for ${segmentOverrides[i].name}`
-			)
-		}
-	}
-
-	// Include additional (non-Segment) services
-	const allIntegrations = additionalServices
-		? additionalServices.map((integration) => {
-				return { ...integration, origin: 'custom' }
-		  })
-		: []
-
-	for (const key in segmentObj) {
-		allIntegrations.push(segmentObj[key])
-	}
-
-	// Returns array with all integrations, with origin key (segment or custom)
-	return allIntegrations
-}
-
-// Group by category for display purposes
-function groupByCategory(
-	integrations: ConsentManagerServiceWithOrigin[]
-): Record<string, ConsentManagerServiceWithOrigin[]> {
-	const grouped: Record<string, ConsentManagerServiceWithOrigin[]> = {}
-
-	integrations.forEach((integration) => {
-		if (Object.prototype.hasOwnProperty.call(grouped, integration.category)) {
-			grouped[integration.category].push(integration)
-		} else {
-			grouped[integration.category] = [integration]
-		}
-	})
-
-	return grouped
-}