other.ts

/**
 * Assorted type definitions
 */

import type {
	DefaultOptions,
	JobOptions,
} from 'gatsby-plugin-component-to-image/lib/types';
import type { ProjectCategory } from './content/projects.ts';
import type { RoleCategory } from './content/roles.ts';
import type {
	AbsolutePathString,
	BgColorString,
	UrlString,
} from './strings.ts';

/**
 * Config object used to define site metadata
 */
export interface SiteMetadataConfig {
	iconPath: string;
	siteUrl: UrlString;
	sourceUrl: UrlString;
	author: {
		name: {
			first: Capitalize<string>;
			last: Capitalize<string>;
		};
		jobTitle: Capitalize<string>;
		alumniOf: Capitalize<string>;
		imageUrl: UrlString;
		username: {
			linkedin: string;
			github: string;
			x: string;
		};
		location: {
			city: Capitalize<string>;
			state: Capitalize<string>;
			country: Capitalize<string>;
		};
	};
}

/**
 * Metadata for a single page
 */
export interface PageMetadata {
	title: string;
	shortTitle: string;
	description: string;
}

/**
 * Page metadata added to the pageContext of pages when they are created
 */
export interface PageMetadataProp {
	pageMetadata: PageMetadata;
}

/**
 * Config object used to define page metadata
 */
export interface PagesMetadataConfig {
	[pagePath: AbsolutePathString]: PageMetadata;
}

/**
 * An enumeration of possible social image types
 */
export enum SocialImageType {
	OpenGraph = 'og',
	X = 'x',
}

/**
 * Config object used to define settings for generating social images
 */
export interface SocialImagesGenerationConfig {
	defaults: Partial<DefaultOptions>;
	types: {
		[SocialImageType.OpenGraph]: Pick<JobOptions, 'size'> &
			Partial<Omit<JobOptions, 'size'>>;
		[SocialImageType.X]: Pick<JobOptions, 'size'> &
			Partial<Omit<JobOptions, 'size'>>;
	};
}

/**
 * Social image metadata added to the pageContext of pages when they are created
 */
export interface SocialImagesMetadataProp {
	socialImagesMetadata: {
		[SocialImageType.OpenGraph]: JobOptions;
		[SocialImageType.X]: JobOptions;
	};
}

/**
 * Image metadata added to the pageContext of {@link https://github.com/jerboa88/gatsby-plugin-component-to-image | gatsby-plugin-component-to-image} components when they are created
 */
export interface ImageMetadataProp {
	imageMetadata: JobOptions;
}

/**
 * An enumeration of possible theme types
 */
export enum ThemeType {
	Light = 'light',
	Dark = 'dark',
}

/**
 * Colors for a single theme
 */
export type Theme = {
	primary: string;
	secondary: string;
	accent: string;
	neutral: string;
	info: string;
	success: string;
	warning: string;
	error: string;
	'base-100': string;
	'base-200': string;
	'base-300': string;
	'base-content': string;
	'primary-content'?: string;
	'secondary-content'?: string;
	'accent-content'?: string;
	'neutral-content': string;
	'info-content'?: string;
	'success-content'?: string;
	'warning-content'?: string;
	'error-content'?: string;
};

/**
 * Config object used to define themes
 */
export interface ThemesConfig {
	[ThemeType.Light]: Theme;
	[ThemeType.Dark]: Theme;
}

/**
 * Config object used to define color mappings
 */
export interface ColorMappingsConfig {
	default: BgColorString;
	projectCategory: Record<ProjectCategory, BgColorString>;
	roleCategory: Record<RoleCategory, BgColorString>;
}

/**
 * A function that sorts two values of the same type
 *
 * @typeParam T - The type of the values to sort
 * @returns A negative number if a should be sorted before b, a positive number if a should be sorted after b, or 0 if they are equal
 */
export type SortFn<T> = (a: T, b: T) => number;

/**
 * A function that filters a value of a certain type
 *
 * @typeParam T - The type of the value to filter
 * @returns True if the value should be included, false otherwise
 */
export type FilterFn<T> = (value: T) => boolean;