studiocms/src/integrations/webVitals/checkForWebVitalsPlugin.ts

Astro Native CMS for AstroDB. Built from the ground up by the Astro community.

/* v8 ignore start */
/*

  This file is ignored by v8 coverage as it contains a utility function only usable from
  with the Astro integration hook context.

*/
import { integrationLogger } from '@withstudiocms/internal_helpers/astro-integration';
import {
	addVirtualImports,
	createResolver,
	defineUtility,
	hasIntegration,
} from 'astro-integration-kit';
import type { StudioCMSPlugin } from '../../plugins.js';

export const webVitalsNameList = ['@studiocms/web-vitals'];

const { resolve } = createResolver(import.meta.url);

/**
 * Checks for the presence of the Web Vitals integration and sets up the necessary configurations.
 *
 * @param params - The parameters provided by the Astro configuration setup.
 * @param opts - Options for configuring the Web Vitals integration.
 * @param opts.name - The name of the Web Vitals integration.
 * @param opts.verbose - A flag indicating whether to log verbose messages.
 * @param opts.version - The minimum version of StudioCMS required for the Web Vitals integration.
 *
 * @returns A StudioCMSPlugin object if the Web Vitals integration is enabled, otherwise null.
 */
export const checkForWebVitals = defineUtility('astro:config:setup')(
	(
		params,
		opts: {
			name: string;
			verbose: boolean;
			version: string;
		}
	) => {
		integrationLogger(
			{ logger: params.logger, logLevel: 'info', verbose: opts.verbose },
			'Checking for Web Vitals integration...'
		);

		let exists = false;

		for (const item of webVitalsNameList) {
			const isEnabled = hasIntegration(params, { name: item });

			if (isEnabled) {
				exists = true;
				// Log that the Web Vitals Integration is Present
				integrationLogger(
					{ logger: params.logger, logLevel: 'info', verbose: opts.verbose },
					'Web Vitals Integration Found!'
				);
			}
		}

		// Add the Web Vitals StudioCMS interface
		addVirtualImports(params, {
			name: opts.name,
			imports: {
				'studiocms-dashboard:web-vitals': `
					export * from "${resolve('./webVital.js')}"
				`,
			},
		});

		// TODO: Dashboard Grid Items
		//         - Page Visits
		const webVitalsPlugin: StudioCMSPlugin = {
			name: 'Web Vitals',
			identifier: '@studiocms/web-vitals',
			studiocmsMinimumVersion: opts.version,
			hooks: {
				'studiocms:config:setup': ({ setDashboard }) => {
					setDashboard({
						dashboardGridItems: [
							{
								name: 'core-web-vitals',
								span: 2,
								variant: 'default',
								header: {
									title: 'Core Web Vitals',
									icon: 'heroicons:chart-pie',
								},
								body: {
									html: '<corevitals></corevitals>',
									components: {
										corevitals: resolve('./dashboard-grid-items/CoreVitals.astro'),
									},
								},
							},
						],
						dashboardPages: {
							admin: [
								{
									title: {
										en: 'Analytics and Vitals',
										de: '',
										es: 'Análisis y datos vitales',
										fr: '',
									},
									icon: 'heroicons:chart-pie',
									route: 'analytics',
									description: 'View the Core Web Vitals and Analytics of your site.',
									sidebar: 'single',
									pageBodyComponent: resolve('./pages/analytics/body.astro'),
									requiredPermissions: 'admin',
								},
							],
						},
					});
				},
			},
		};

		if (exists) {
			return webVitalsPlugin;
		}

		return null;
	}
);
/* v8 ignore stop */