vowel 0.1.46 → 0.2.2

package/src/lib/utilities/getFolder.js

@@ -1,16 +0,0 @@
-export default function getFolder(website, path) {
-	const dotPath = path
-		.replace(/^\//, '') // Remove preceding slash
-		.replace(/\/$/, '') // Remove trailing slash
-		.replaceAll('/', '.'); // Convert to dots
-
-	let drill = website;
-
-	dotPath.split('.').forEach((segment) => {
-		if (segment) {
-			drill = drill[segment];
-		}
-	});
-
-	return drill;
-}

package/src/lib/utilities/getFolderLabel.js

@@ -1,12 +0,0 @@
-import { getFileLabel } from '.';
-
-const fallBackLabel = 'Untitled';
-
-export default function getFolderLabel(folder, shorter, date) {
-	if (typeof folder !== 'object') return 'Untitled';
-	return (
-		getFileLabel(folder['_'], shorter, date) ||
-		getFileLabel(folder['$'], shorter, date) ||
-		fallBackLabel
-	);
-}

package/src/lib/utilities/getMetadata.js

@@ -1,46 +0,0 @@
-import { XMLParser } from "fast-xml-parser"
-import urlMetadata from 'url-metadata';
-
-export default async function getMetadata({ cache, url }) {
-	if (!cache[url]) {
-		try {
-			const urlObject = new URL(url);
-			const allMetadata = await urlMetadata(urlObject.href, {
-				includeResponseBody: true,
-				ensureSecureImageRequest: true
-			});
-
-			const parser = new XMLParser({
-				unpairedTags: ["!doctype", "meta", "link", "hr", "br", "img"],
-				ignoreAttributes: false,
-				stopNodes: ["*.pre", "*.script"],
-				processEntities: true,
-				htmlEntities: true
-			})
-	
-			let parsedData = parser.parse(allMetadata.responseBody)
-			const webmentionEndpoint = parsedData?.html?.head?.link?.find(link => {
-				return link["@_rel"] === "webmention"
-			})?.["@_href"]
-
-			const metadata = {
-				image: allMetadata['og:image'],
-				ogURL: allMetadata['og:url'],
-				canonicalURL: allMetadata.canonical,
-				title: allMetadata.title,
-				ogTitle: allMetadata['og:title'],
-				author: allMetadata.author,
-				description: allMetadata.description,
-				webmentionEndpoint
-			};
-
-			cache[url] = metadata;
-
-			return { metadata }
-		} catch (error) {
-			console.log({ fetchingMetadataError: error })
-			return { metadata: undefined }
-		}
-	}
-	return { metadata: cache[url] }
-}

package/src/lib/utilities/getPage.js

@@ -1,25 +0,0 @@
-// import objectPath from 'object-path';
-
-/**
- * Takes a file URL and a website object and returns the file object.
- * @param {import('./processMarkdownFiles').Directory} website - A website object.
- * @param {string} path - A `/`-delimited filepath.
- * @returns {import('./processMarkdownFiles').MarkdownFile}
- */
-export default function getPage(website, path) {
-	let page = website;
-
-	// const dotPath = path.replace(/^\//, '').replaceAll('/', '.') + (path ? '.' : '') + '$';
-
-	const segments = path
-		.replace(/^\//, '')
-		.concat(path ? '/$' : '$')
-		.split('/');
-
-	segments.forEach((segment) => {
-		if (segment === '_') return page[segment];
-		if (typeof page === 'object' && page !== null) page = page[segment];
-	});
-
-	return page;
-}

package/src/lib/utilities/getPagesByFolder.js

@@ -1,95 +0,0 @@
-// @ts-ignore
-import { getFolder, getFileLabel } from '.';
-
-// @ts-ignore
-const excludedFileNames = ['_'];
-
-/**
- * Traverse a folder to get all of the pages.
- * @param {import('./processMarkdownFiles').Directory} folder - The path to the folder to retrieve.
- * @param {boolean} root - Whether this is the root of the recursion.
- * @returns {Array<Page>}
- */
-function traverseFolder(folder, root = false, property = '.') {
-	let propertyKey = (property || '.').split('.')[0];
-	let propertyValue = (property || '.').split('.')[1];
-
-	let pages = [];
-
-	for (let key in folder) {
-		if (!key.startsWith('$') || key.length === 1) {
-			if (key === '$') {
-				if (!root) {
-					if (propertyKey) {
-						if (
-							folder[key].hasOwnProperty(propertyKey) &&
-							folder[key][propertyKey] === propertyValue
-						) {
-							pages.push(folder[key]);
-						}
-					} else {
-						pages.push(folder[key]);
-					}
-				}
-				// if (
-				// 	!root &&
-				// 	folder[key].$?.hasOwnProperty(propertyKey) &&
-				// 	folder[key][propertyKey] === propertyValue
-				// )
-				// 	pages.push(folder[key]);
-			} else if (key !== '_') {
-				const child = folder[key];
-
-				// @ts-ignore
-				pages.push(...traverseFolder(child, false, property));
-			}
-		}
-	}
-
-	// @ts-ignore
-	return pages;
-}
-
-/**
- * Description
- * @param {Page} a
- * @param {Page} b
- * @returns {number}
- */
-function sortPage(a, b) {
-	if (a.hasOwnProperty('date') && !b.hasOwnProperty('date')) return -1;
-	else if (!a.hasOwnProperty('date') && b.hasOwnProperty('date')) return 1;
-	else if (a.date && b.date) {
-		const aDate = Number(new Date(a.date.output));
-		const bDate = Number(new Date(b.date.output));
-		return bDate - aDate;
-	} else if (getFileLabel(a) > getFileLabel(b)) return 1;
-	return -1;
-}
-
-/**
- * @typedef {import('./processMarkdownFiles').MarkdownFile} Page
- */
-
-/**
- * Recursively get all of the pages in a folder.
- * @param {import('./processMarkdownFiles').Directory} website - The entire website.
- * @param {string} path - The path to the folder to retrieve.
- * @param {number | undefined} count - Number of pages to return.
- * @returns {Array<Page>}
- */
-export default function getPagesByFolder(
-	website,
-	path,
-	excludeRoot = true,
-	count = undefined,
-	property
-) {
-	const folder = getFolder(website, path);
-
-	const pages = traverseFolder(folder, excludeRoot, property);
-
-	pages.sort(sortPage);
-
-	return pages.slice(0, count);
-}

package/src/lib/utilities/index.js

@@ -1,22 +0,0 @@
-export { default as getPage } from './getPage';
-export { default as getFileLabel } from './getFileLabel';
-export { default as getFolderLabel } from './getFolderLabel';
-export { default as getFolder } from './getFolder';
-export { default as getPagesByFolder } from './getPagesByFolder';
-export { default as buildURL } from './buildURL';
-export { default as checkFileExists } from './checkFileExists';
-export { default as writeCache } from './writeCache';
-export { default as readMarkdownFile } from './readMarkdownFile';
-export { default as processMarkdownFiles } from './processMarkdownFiles';
-export { default as loadCache } from './loadCache';
-export { default as mutateMarkdownFrontmatter } from './mutateMarkdownFrontmatter';
-export { default as isObject } from './isObject';
-export { default as regexPatterns } from './regexPatterns';
-export { default as mutateMarkdownAST } from './mutateMarkdownAST';
-export { default as parseDate } from './parseDate';
-export { default as resolveHomeDirPath } from './resolveHomeDirPath';
-export { default as createPageClass } from './createPageClass';
-export { default as createFolderClass } from './createFolderClass';
-export { default as isActiveLink } from './isActiveLink';
-export { default as sendWebmention } from "./sendWebmention"
-export { default as getMetadata } from "./getMetadata"

package/src/lib/utilities/isActiveLink.js

@@ -1,12 +0,0 @@
-export default function isActiveLink(segments, key) {
-	if (!segments?.[0] && !key) {
-		return 'page';
-	}
-	if (segments.length === 1 && segments[0] === key) {
-		return 'page';
-	}
-	if (segments.length > 1 && segments[0] === key) {
-		return 'true';
-	}
-	return undefined;
-}

package/src/lib/utilities/isObject.js

@@ -1,8 +0,0 @@
-/**
- * Check if a value is an object
- * @param {any} value - Value to check.
- * @returns {boolean}
- */
-export default function isObject(value) {
-	return typeof value === 'object' && !Array.isArray(value) && value !== null;
-}

package/src/lib/utilities/loadCache.js

@@ -1,28 +0,0 @@
-import fs from 'fs/promises';
-import resolveHomeDirPath from './resolveHomeDirPath';
-
-/**
- * @typedef {Object<string, object>} Cache
- * @description A map of URLs to their metadata.
- */
-
-/**
- * Load a cache of URLs
- * @returns {Promise<Cache>}
- */
-export default async function loadCache(homeDir) {
-	const cachePath = resolveHomeDirPath('.cache.json', homeDir);
-
-	try {
-		let data = await fs.readFile(cachePath);
-		return JSON.parse(data);
-	} catch (error) {
-		if (error.code === 'ENOENT') {
-			await fs.writeFile(cachePath, '{}', 'utf8');
-			console.log('.cache.json created');
-		} else {
-			throw error;
-		}
-	}
-	return {};
-}

package/src/lib/utilities/mutateMarkdownAST.js

@@ -1,68 +0,0 @@
-import { sendWebmention, getMetadata } from './';
-
-function isURL(string) {
-	try {
-		new URL(string)
-		return true
-	} catch (e) {
-		return false
-	}
-}
-
-
-
-export default async function mutateMarkdownAST(ast, cache, webmentions, pageURL) {
-	const promises = ast.map(async (node) => {
-		// TODO: Improve this URL regex
-		if (node.type === 'paragraph') {
-
-			// URLs
-			if (
-				node.children?.length === 1 &&
-				node.children?.[0]?.type === "link" &&
-				node.children?.[0]?.children?.length === 1
-			) {
-				node.type = 'url';
-				const { url } = node.children[0];
-				node.url = url
-
-				const { metadata } = await getMetadata({ cache, url })
-
-				node.metadata = metadata;
-				node.value = url;
-				delete node.children;
-
-				try {
-					console.log("Looking for webmentions")
-					if (webmentions && !webmentions.find(webmention => webmention.target === url)) {
-						console.log("Found new page")
-						webmentions.push({
-							target: url,
-							status: "new"
-						})
-					} else if (webmentions) {
-						console.log("Found new webmention")
-						const webmention = webmentions.find(webmention => webmention.target === url)
-						if (webmention.status === "new" || webmention.status === "failure" || webmention.status === "429") {
-							console.log("Sending webmention")
-							webmention.status = await sendWebmention({ endpoint: metadata.webmentionEndpoint, target: webmention.target, source: pageURL })
-						}
-					}
-				} catch (error) {
-					console.log({ webmentionError: error })
-				}
-			} else if (node.children[0].type === 'image') {
-				node.type = 'figure';
-				if (node?.children[1]?.type === 'text') {
-					node.children[1].type = 'figcaption';
-				}
-			}
-		}
-
-		if (node.children) {
-			await mutateMarkdownAST(node.children, cache);
-		}
-	});
-
-	await Promise.all(promises);
-}

package/src/lib/utilities/mutateMarkdownFrontmatter.js

@@ -1,113 +0,0 @@
-import urlMetadata from 'url-metadata';
-import { regexPatterns, isObject, parseDate, sendWebmention, getMetadata } from '.';
-
-/**
- * Description
- * @param {any} value - Any frontmatter value
- * @returns {any}
- */
-function imputeType(value) {
-	if (value === null || value === undefined || Number.isNaN(value)) return 'nullish';
-	if (typeof value === 'boolean') return 'boolean';
-	if (typeof value === 'number') return 'number';
-	if (parseDate(value)) return 'date';
-	if (isObject(value)) return 'object';
-	if (Array.isArray(value)) return 'array';
-	if (typeof value === 'string') {
-		if (value.match(regexPatterns.img)) return 'image';
-		if (value.match(regexPatterns.pdf)) return 'pdf';
-		if (value.match(regexPatterns.url)) return 'url';
-		if (value.match(regexPatterns.path)) return 'path';
-		return 'string';
-	}
-	console.error('Unknown frontmatter data type: ' + value);
-	return 'other';
-}
-
-export default async function mutateMarkdownFrontmatter(frontmatter, cache, webmentions, pageURL) {
-	const keys = Object.keys(frontmatter);
-
-	const promises = keys.map(async (key) => {
-		const input = frontmatter[key];
-
-		const type = imputeType(input);
-
-		switch (type) {
-			case 'object': {
-				await mutateMarkdownFrontmatter(input, cache);
-				frontmatter[key] = {
-					type: 'object',
-					output: input
-				};
-				break;
-			}
-			case 'array': {
-				await mutateMarkdownFrontmatter(input, cache);
-				frontmatter[key] = {
-					type: 'array',
-					output: input
-				};
-				break;
-			}
-			case 'date': {
-				frontmatter[key] = {
-					type: 'date',
-					output: parseDate(input),
-					input
-				};
-				break;
-			}
-			case 'image': {
-				frontmatter[key] = {
-					type: 'image',
-					output: input,
-					input
-				};
-				break;
-			}
-			case 'pdf': {
-				frontmatter[key] = {
-					type: 'pdf',
-					output: input,
-					input
-				};
-				break;
-			}
-			case 'url': {
-				const { metadata } = await getMetadata({
-					cache,
-					url: input
-				})
-
-				frontmatter[key] = {
-					type: 'url',
-					output: metadata || input,
-					input
-				};
-
-				try {
-					if (webmentions && !webmentions.find(webmention => webmention.target === input)) {
-						webmentions.push({
-							target: input,
-							status: "new"
-						})
-					} else if (webmentions) {
-						const webmention = webmentions.find(webmention => webmention.target === input)
-						if (webmention.status === "new") {
-							webmention.status = await sendWebmention({ endpoint: metadata.webmentionEndpoint, target: webmention.target, source: pageURL })
-						}
-					}
-
-				} catch (error) {
-					console.log({ webmentionsError: error })
-				}
-				break;
-			}
-			case 'nullish': {
-				frontmatter[key] = undefined;
-			}
-		}
-	});
-
-	await Promise.all(promises);
-}

package/src/lib/utilities/parseDate.js

@@ -1,43 +0,0 @@
-import dates from 'any-date-parser';
-import ago from 'any-date-parser/src/formats/ago/ago.js';
-import chinese from 'any-date-parser/src/formats/chinese/chinese.js';
-import dayMonth from 'any-date-parser/src/formats/dayMonth/dayMonth.js';
-import dayMonthname from 'any-date-parser/src/formats/dayMonthname/dayMonthname.js';
-import monthDay from 'any-date-parser/src/formats/monthDay/monthDay.js';
-import monthnameDay from 'any-date-parser/src/formats/monthnameDay/monthnameDay.js';
-import today from 'any-date-parser/src/formats/today/today.js';
-
-dates.removeFormat(ago);
-dates.removeFormat(chinese);
-dates.removeFormat(dayMonth);
-dates.removeFormat(dayMonthname);
-dates.removeFormat(monthDay);
-dates.removeFormat(monthnameDay);
-dates.removeFormat(today);
-
-/*
-Left in the following formats:
-
-microsoftJson
-dayMonthYear
-dayMonthnameYear
-monthDayYear
-monthnameDayYear
-twitter
-yearMonthDay
-atSeconds
-time12Hours
-time24Hours
-*/
-
-export default function parseDate(maybeDate) {
-	if (!maybeDate) return false;
-	if (maybeDate instanceof Date) return maybeDate;
-	if (typeof maybeDate === 'number') return false;
-	if (typeof maybeDate === 'string' && maybeDate.match(/^\d+$/)) return false;
-	const parsedDate = dates.attempt(maybeDate);
-	if (parsedDate.invalid) return false;
-	const { month, day, year } = parsedDate;
-	const date = new Date(`${year}-${month}-${day}`);
-	return date;
-}