pompy.dev/source/types/typing.ts

export interface Map {
	// key: YYYY-MM-DD
	// value: url
	date: { [key: string]: string[] }

	// key: tag name
	// value: url
	tags: {
		[key: string]: string[]
	}

	// list of all meta data
	meta: {
		tags: string[]
	}

	// searchable, non-series posts
	// must have a post date
	// tag is not required
	posts: {
		[key: string]: PostData
	}

	// series posts have "previous post" and "next post" button so they need to be ordered
	series: { [key: string]: Series }

	// urls of unsearchable posts
	// it is here to quickly check if a post exists or not
	unsearchable: { [key: string]: { title: string } }
}

/**
 * General
 */

export interface Badge {
	icon: string
	text: string
}

export enum ParseMode {
	POSTS,
	SERIES,
	UNSEARCHABLE,
	PORTFOLIO,
}

export interface MarkdownData {
	content: string
	date: string
	title: string
	tags: string[]
}

export interface PostData {
	title: string
	date: string
	readTime: string
	wordCount: number
	tags?: string[]
}

export interface FetchedPage {
	title: string
	date: string
	readTime: string
	wordCount: number
	tags: string[]
	toc?: string
	content: string
}

/**
 * Series
 */

export interface Series {
	title: string
	date: string
	readTime: string
	wordCount: number
	order: string[]
	length: number
	tags?: string[]
}

export interface SeriesMap {
	// key: url
	[key: string]: SeriesEntry[]
}

export interface SeriesEntry {
	index: number
	url: string
}

/**
 * Portfolio
 */

export interface PortfolioData {
	overview: string
	projects: PortfolioProject[]
}

export interface PortfolioOverview {
	// link to my github
	github: string
	description: string
}

export interface PortfolioProject {
	// shown in card

	name: string
	image: string // url to the image
	overview: string
	badges: Badge[]
	repo: string // url of the git repository

	// page content

	description: string // html render of markdown description
}