vowel 0.1.46 → 0.2.2

package/src/lib/utilities/processMarkdownFiles.js

@@ -1,243 +0,0 @@
-import fs from 'fs/promises';
-import path from 'path';
-// @ts-ignore
-import { buildURL, checkFileExists, readMarkdownFile } from '.';
-
-function DefaultFile(url) {
-	return {
-		ast: [
-			{
-				type: 'paragraph',
-				children: [
-					{
-						type: 'h1',
-						value: 'hey there',
-						// value: url + '?count=10',
-						position: {
-							start: {
-								line: 5,
-								column: 1,
-								offset: 25
-							},
-							end: {
-								line: 5,
-								column: 8,
-								offset: 32
-							}
-						}
-					}
-				],
-				position: {
-					start: {
-						line: 5,
-						column: 1,
-						offset: 25
-					},
-					end: {
-						line: 5,
-						column: 8,
-						offset: 32
-					}
-				}
-			}
-		],
-		url
-	};
-}
-
-function DefaultDirectory(path) {
-	return {
-		$: DefaultFile(path),
-		_: DefaultFile(path)
-	};
-}
-
-/** @typedef {Object} AdditionalFileProperties
- * @property {string} [url] - URL to the page for the file.
- * @property {number} [date] - Document date.
- */
-
-/** @typedef {import("./readMarkdownFile").ParsedMarkdown & AdditionalFileProperties} MarkdownFile */
-
-/**
- * @typedef {Object} Subdirectory
- * @description A subdirectory of markdown files
- * @property {MarkdownFile} $ A home file
- * @property {MarkdownFile} _ A settingsfile
- * @property {Object.<string, Object>} [additionalProps] Files or child directories.
- */
-
-/**
- * @typedef {Object.<string, MarkdownFile | Subdirectory>} Directory
- * @description A directory of markdown files
- * @property {MarkdownFile} $ A home file.
- * @property {MarkdownFile} _ A settings file.
- * @property {Object.<string, MarkdownFile | Subdirectory>} [additionalProps] Files or child directories.
- */
-
-/**
- * Recursively read a directory of markdown files and return an object of the files.
- * @param {string} directoryPath - The directory to read.
- * @param {string} parents - A string representing the parent directories.
- * @param {import('./loadCache').Cache} cache
- * @returns {Promise<Directory>}
- */
-
-/**
- * Recursively read a directory of markdown files and return an object of the files.
- * @param {string} folderPath - The directory to read.
- * @param {string} parents - A string representing the parent directories.
- * @param {import('./loadCache').Cache} cache
- * @returns {Promise<Directory>}
- */
-async function readFolder(folderPath, parents, cache, hidden, publishedData, domain) {
-	function filterFiles(file) {
-		if (file.name.startsWith('.')) return false;
-		if (file.name.startsWith('README')) return false;
-		if (file.isFile() && !file.name.endsWith('.md')) return false;
-		if (file.name === 'node_modules') return false;
-		if (file.name === 'assets') return false;
-		if (file.name === 'templates') return false;
-		return true;
-	}
-
-	let files = (await fs.readdir(folderPath, { withFileTypes: true })).filter(filterFiles);
-
-	console.log(`filesfound:${files.length}`);
-
-	const promises = files.map(
-		async (file) => await readFile(file, parents, cache, folderPath, hidden, publishedData, domain)
-	);
-
-	const folder = (await Promise.all(promises)).reduce((acc, obj) => ({ ...acc, ...obj }), {});
-
-	if (typeof folder === 'object' && !folder?.$) {
-		folder.$ = DefaultFile(parents || '/');
-		folder.$.imputedProperties = {
-			fileName: parents.split('/').at(-1) || 'Home'
-		};
-	}
-
-	if (typeof folder === 'object' && !folder?._) {
-		folder._ = DefaultFile(parents);
-	}
-
-	return folder;
-}
-
-function buildHREF(url, domain) {
-	try {
-		const urlObj = new URL(domain)
-		urlObj.pathname = url
-		return urlObj.href
-	} catch (e) {
-		return undefined
-	
-	}
-}
-
-async function readFile(file, parents, cache, folderPath, hidden, publishedData, domain) {
-	const route = path.parse(file.name).name;
-	const url = buildURL(parents, route);
-	const filePath = path.join(folderPath, file.name);
-	
-	const extension = path.extname(file.name);
-	
-	const hide = (file.name.startsWith('$') && file.name.length > 1) || hidden;
-	
-	if (file.isFile() && extension === '.md') {
-		const href = buildHREF(url, domain)
-		const startLoad = performance.now();
-		const shortPath = parents + '/' + file.name;
-
-		let filePublishedData = publishedData?.find(item => item.path === url) 
-		if(publishedData && !filePublishedData) {
-			publishedData.push({
-				path: url,
-				webmentions: []
-			})
-			filePublishedData = publishedData.at(-1)
-		}
-		
-		const { ast, frontmatter, imputedProperties } = await readMarkdownFile(filePath, cache, filePublishedData, href);
-
-		const loadTime = (performance.now() - startLoad).toFixed(2);
-		// console.log(`📄 ${shortPath} (${loadTime}ms)`);
-		console.log('fileread');
-		if (frontmatter.published == false) return;
-		if (file.name === 'home.md' || file.name === 'settings.md') {
-			const key = file.name === 'home.md' ? '$' : '_';
-			return {
-				[key]: {
-					...frontmatter,
-					imputedProperties,
-					ast,
-					url
-				}
-			};
-		}
-
-		return {
-			[route]: {
-				$: {
-					...frontmatter,
-					imputedProperties,
-					ast,
-					// url,
-					url: hide ? false : url
-				}
-			}
-		};
-	}
-
-	/** @type Directory */
-	if (file.isDirectory()) {
-		const settingsPath = path.join(folderPath, file.name, 'settings.md');
-		const settingsFileExists = await checkFileExists(settingsPath);
-
-		/** @type {MarkdownFile} */
-		const _ = settingsFileExists ? await readMarkdownFile(settingsPath, cache) : DefaultFile(url);
-
-		const shortPath = parents + '/' + file.name;
-
-		const startLoad = performance.now();
-		const folder = await readFolder(path.join(folderPath, file.name), url, cache, hide, publishedData, domain);
-
-		const loadTime = (performance.now() - startLoad).toFixed(2);
-		// console.log(`📁 ${shortPath} (${loadTime}ms)`);
-
-		if (!folder.hasOwnProperty('$')) {
-			const $ = DefaultFile(url);
-			Object.assign(folder, { $ });
-		}
-		if (!folder.hasOwnProperty('_')) {
-			const _ = DefaultFile(url);
-			Object.assign(folder, { _ });
-		}
-
-		return {
-			[file.name]: folder
-		};
-	}
-}
-
-/**
- * @typedef {Object} ProcessedFiles
- * @description The return value of the processing function.
- * @property {Directory} folder - The root directory.
- * @property {Cache} finalCache - The application cache.
- */
-
-/**
- * Recursively reads the markdown files in a directory and returns a representative object.
- * @param {import('./loadCache').Cache} cache
- * @returns {Promise<ProcessedFiles>}
- */
-export default async function processMarkdownFiles(cache, publishedData, domain) {
-	/** @type {Array<string>} */
-	// @ts-ignore
-	const [homeDir] = $home;
-	const folder = await readFolder(homeDir, '', cache, null, publishedData, domain);
-
-	return { folder, finalCache: cache };
-}

package/src/lib/utilities/readMarkdownFile.js

@@ -1,188 +0,0 @@
-import fs from 'fs/promises';
-import { remark } from 'remark';
-import remarkFrontmatter from 'remark-frontmatter';
-import remarkDirective from 'remark-directive';
-import remarkHTML from 'remark-html';
-import remarkGFM from 'remark-gfm';
-import yaml from 'js-yaml';
-import { toString } from 'mdast-util-to-string';
-import path from 'path';
-
-import { mutateMarkdownAST, mutateMarkdownFrontmatter } from '.';
-
-/**
- * @typedef {Object} FrontmatterNode
- * @property {"yaml"} type - The type is yaml.
- * @property {string} value - The value of the node.
- * @property {Object} [position] - The position of the node.
- */
-
-/**
- * Parse a frontmatter node to a JS object.
- * @param {FrontmatterNode | undefined} frontmatterNode - A markdown node of type "yaml".
- * @returns {Object} A JS object containing the frontmatter
- */
-function parseFrontmatter(frontmatterNode) {
-	if (!frontmatterNode) return {};
-	const frontmatter = yaml.load(frontmatterNode.value);
-	if (frontmatter && typeof frontmatter === 'object') {
-		return frontmatter;
-	}
-	return {};
-}
-
-function deduceDescriptionFromAST(ast) {
-	for (let i = 0; i < ast?.length; i++) {
-		if (ast?.[i]?.type === 'paragraph') {
-			const firstParagraph = toString(ast[i]);
-			if (firstParagraph.length > 150) {
-				return firstParagraph.slice(0, 150);
-			} else if (firstParagraph.length > 1) {
-				return firstParagraph;
-			}
-		}
-	}
-	return null;
-}
-
-function deduceImageFromAST(ast) {
-	for (let i = 0; i < ast?.length; i++) {
-		const node = ast?.[i]
-		if (node.type === 'figure') {
-			for(let i = 0; i < node.children.length; i++) {
-				const child = node.children[i]
-				if(child.type === "image") {
-					return child.url
-				}
-			}
-		}
-	}
-	return null;
-}
-
-function demoteHeadings(ast, start) {
-	for (let i = start; i < ast.length; i++) {
-		const node = ast[i];
-		if (node.type === 'heading') {
-			node.depth = node.depth + 1;
-		}
-	}
-}
-
-function checkHeadings(ast, start = 1) {
-	for (let i = start; i < ast.length; i++) {
-		if (ast[i]?.depth === 1) {
-			return true;
-		}
-	}
-	return false;
-}
-
-function extractTitleFromHeading(node) {
-	return node?.children?.[0].value;
-}
-
-function imputeTitleFromAST(ast) {
-	if (ast?.[0]?.depth === 1) {
-		return extractTitleFromHeading(ast[0]);
-	}
-
-	return null;
-}
-
-/**
- * @typedef {Object} ParsedMarkdown
- * @property {Object.<string, *>} [frontmatter] - Metadata for the document.
- * @property {Array<Object>} ast - The content of the document.
- * @property {Object} imputedProperties - Metadata imputed from content.
- * @property {string} [url] - URL for the page.
- * @description An object containing the parsed frontmatter and filtered AST.
- */
-
-/**
- * Reads a Markdown file and parses its content into frontmatter and abstract syntax tree (AST).
- * It also filters out YAML frontmatter nodes from the AST.
- *
- * @async
- * @function
- * @param {string} filePath - The path to the Markdown file.
- * @param {Object} cache - An optional cache object that can be passed to mutate the AST.
- * @returns {Promise<ParsedMarkdown>}
- * @throws {Error} Will throw an error if the file cannot be read or parsed.
- */
-export default async function readMarkdownFile(filePath, cache, publishedData, url) {
-	const fileName = path.basename(filePath.slice(0, -3));
-
-	const fileContent = await fs.readFile(filePath, 'utf8');
-	const markdownParser = remark().use(remarkFrontmatter, ['yaml']).use(remarkHTML);
-
-	const parsedMarkdown = markdownParser.parse(fileContent);
-	const frontmatterNode = parsedMarkdown.children.find((node) => node.type === 'yaml');
-	const frontmatter = frontmatterNode?.type === 'yaml' ? parseFrontmatter(frontmatterNode) : {};
-	const ast = remark()
-		.use(remarkDirective)
-		.use(remarkFrontmatter)
-		.use(remarkGFM)
-		.parse(fileContent);
-
-	const footnotes = [];
-
-	for (let i = 0; i < ast.children.length; i++) {
-		if (ast.children[i].type === 'footnoteDefinition') {
-			footnotes.push(ast.children[i]);
-		}
-	}
-
-	if (footnotes.length) {
-		ast.children.push({
-			type: 'footnotes',
-			children: footnotes
-		});
-	}
-
-	// ast.children.sort((a, b) => {
-	// 	if (a.type !== 'footnoteDefinition' && b.type === 'footnoteDefinition') return -1;
-	// 	return 0;
-	// });
-
-	const filteredAST = ast.children.filter((child) => child.type !== 'yaml');
-
-	const imputedTitle = imputeTitleFromAST(filteredAST);
-
-	if (imputedTitle) {
-		filteredAST.shift();
-	}
-
-	if (imputedTitle && checkHeadings(filteredAST, 1)) {
-		demoteHeadings(filteredAST, 1);
-	}
-
-	if (!frontmatter.title && imputedTitle) frontmatter.title = imputedTitle;
-
-	
-
-	const imputedProperties = {
-		description: deduceDescriptionFromAST(filteredAST),
-		title: imputedTitle,
-		fileName
-	};
-
-
-	const webmentions = publishedData?.webmentions
-
-	const promises = [mutateMarkdownAST(ast.children, cache, webmentions, url)];
-
-	// Don't mutate frontmatter on the settings pages
-	if (!filePath.endsWith('settings.md'))
-		promises.push(mutateMarkdownFrontmatter(frontmatter, cache, webmentions));
-
-	await Promise.all(promises);
-
-	const imputedImage = deduceImageFromAST(filteredAST)
-
-	if(imputedImage) {
-		imputedProperties.image = imputedImage
-	}
-	
-	return { frontmatter, ast: filteredAST, imputedProperties };
-}

package/src/lib/utilities/regexPatterns.js

@@ -1,12 +0,0 @@
-const img = /^https?:\/\/\S+(avif|gif|heif|jpeg|jpg|png|tiff|webp)(\?\S+)?/;
-const pdf = /^https?:\/\/\S+(pdf)(\?\S+)?/;
-const url = /^https?:\/\/\S+$/;
-const path = /^\/[\/\S]+$/;
-// const humanDate = /^((Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec|January|February|March|April|May|June|July|August|September|October|November|December)[\d\040,\/(nd|rd|st|th)]{8,12}|[\d\040,\/(nd|rd|st|th)]{1,5}(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec|January|February|March|April|May|June|July|August|September|October|November|December),?\040\d{2,4})$/;
-
-export default {
-	url,
-	img,
-	path,
-	pdf
-};

package/src/lib/utilities/resolveHomeDirPath.js

@@ -1,5 +0,0 @@
-import path from 'path';
-
-export default function resolveHomeDirPath(filename, homeDir) {
-	return path.normalize(path.join(homeDir, filename));
-}

package/src/lib/utilities/sendWebmention.js

@@ -1,34 +0,0 @@
-export default async function sendWebmention({ endpoint, source, target }) {
-    try {
-        if (endpoint) {
-            const params = new URLSearchParams()
-            params.append('source', source)
-            params.append('target', target)
-
-            const response = await fetch(endpoint, {
-                method: "POST",
-                body: params,
-                headers: {
-                    'Content-Type': 'application/x-www-form-urlencoded'
-                }
-            })
-
-            console.log({
-                source, target,
-                webmentionResponse: await response.json()
-            })
-
-            if(response.status === 429) {
-                return "429"
-            } else if (response.status >= 200 && response.status < 300) {
-                return "success"
-            } else {
-                console.log({ failure: await response.json() })
-                return "failure"
-            }
-        }
-    } catch (error) {
-        console.log({ error })
-        return "error"
-    }
-}

package/src/lib/utilities/writeCache.js

@@ -1,14 +0,0 @@
-import fs from 'fs/promises';
-import { resolveHomeDirPath } from '.';
-
-export default async function writeCache(data, homeDir) {
-	const cachePath = resolveHomeDirPath('.cache.json', homeDir);
-
-	try {
-		const jsonData = JSON.stringify(data, null, 2);
-		await fs.writeFile(cachePath, jsonData, 'utf8');
-		console.log('Cache updated');
-	} catch (error) {
-		console.error('Error updating cache data:', error);
-	}
-}

package/src/routes/$vowel/published.json/+server.js

@@ -1,54 +0,0 @@
-import {
-	processMarkdownFiles,
-	loadCache,
-	checkFileExists,
-	readMarkdownFile
-} from '$lib/utilities';
-import { join } from 'path';
-
-
-export const prerender = true;
-
-async function getPublishedData(domain) {
-	try {
-		const publishedURL = new URL("/$vowel/published.json", domain)
-		const publishedDataResponse = await fetch(publishedURL.href)
-		const publushedDataJSON = await publishedDataResponse.json()
-		return publushedDataJSON
-	} catch (e) {
-		console.log(e)
-		return undefined
-	}
-}
-
-export async function GET() {
-	// everything.request.url
-
-	let settings
-
-	const settingsPath = join($home[0], "/settings.md")
-	const settingsExists = await checkFileExists(settingsPath);
-	if (settingsExists) {
-		settings = await readMarkdownFile(settingsPath)
-	}
-
-	// Get published articles from live site
-	const publishedData = await getPublishedData(settings.frontmatter.domain)
-
-	if($publish[0]) {
-		const initialCache = await loadCache($home[0]);
-
-
-		const { folder: website } = await processMarkdownFiles(initialCache, publishedData, settings.frontmatter.domain);
-	}
-
-	const headers = {
-		'Cache-Control': 'max-age=0, s-maxage=1',
-		'Content-Type': 'text/plain'
-	};
-
-	const response = new Response(JSON.stringify(publishedData), {
-		headers
-	});
-	return response;
-}

package/src/routes/+error.svelte

@@ -1,110 +0,0 @@
-<script>
-	import { page } from '$app/stores';
-	import {
-		Nav,
-		Page,
-		Breadcrumbs,
-		Sitemap,
-		ResetStyles,
-		DefaultStyles,
-		TypographyStyles,
-		NoStyles
-	} from '$lib/components/index.js';
-	import { invalidateAll } from '$app/navigation';
-
-	const themes = {
-		none: NoStyles,
-		reset: ResetStyles,
-		typography: TypographyStyles,
-		default: DefaultStyles
-	};
-
-	let { error: data } = $page;
-
-	const { website } = $derived(data);
-
-	const { slogan, theme } = $derived(website?._);
-
-	// Import CSS for HMR in dev mode
-	if (data.dev && data.files.css.exists) {
-		import(/* @vite-ignore */ data.files.css.path);
-	}
-
-	const siteTitle = website._.title;
-
-	function makePageMetaTitle() {
-		if (siteTitle) return `Page not found = ${siteTitle}`;
-		return `Page not found`;
-	}
-
-	function getFavicon() {
-		if (website._?.icon)
-			return `data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 20 90 60%22><text y=%22.9em%22 font-size=%2290%22>${website._.icon}</text></svg>`;
-		if (data.files.favicon.exists) return '/favicon.png';
-		return false;
-	}
-
-	const favicon = getFavicon();
-
-	$effect(() => {
-		// Update website on file change
-		if (import.meta.hot) {
-			import.meta.hot.on('vowel:update', ({ path, file }) => {
-				invalidateAll().then(() => {
-					window.location.reload();
-				});
-			});
-			import.meta.hot.on('vowel:refresh', () => {
-				console.log('Refresh');
-				invalidateAll().then(() => {
-					window.location.reload();
-				});
-			});
-		}
-	});
-</script>
-
-<svelte:component this={themes[theme || 'default']} />
-
-<svelte:head>
-	<title>{makePageMetaTitle()}</title>
-	<meta property="og:site_name" content={website._.title} />
-	{#if favicon}
-		<link rel="icon" href={favicon} />
-	{/if}
-	{#if !data.dev && data.files.css.exists}
-		<link rel="stylesheet" href="/styles.css" />
-	{/if}
-</svelte:head>
-
-<div data-sveltekit-preload-data="hover" class="page 404">
-	<header>
-		{#if website._.logo}
-			<a href="/" class="site-logo">
-				{#if website._.logo.endsWith('.svg')}
-					<object type="image/svg+xml" data={website._.logo} title={website._.title || undefined}
-					></object>
-				{:else}
-					<img alt="website logo" src={website._.logo} />
-				{/if}
-			</a>
-		{/if}
-		{#if siteTitle}
-			<a href="/" class="site-title">{siteTitle}</a>
-		{/if}
-		{#if website._.slogan}
-			<p class="slogan">{website._.slogan}</p>
-		{/if}
-		<Nav folder={website} segments={['']} />
-	</header>
-	<main>
-		<h1>Page Not Found</h1>
-	</main>
-	<nav class="sidebar">
-		<Sitemap section={website} segments={['']} root />
-	</nav>
-	<footer>
-		© {website._.author ? website._.author + ' ' : ''}
-		{new Date().getFullYear()}
-	</footer>
-</div>