astro-accelerator-utils 0.0.32 → 0.0.33

package/index.d.mts

@@ -4,5 +4,6 @@ import * as PostOrdering from "./lib/postOrdering.mjs";
 import * as PostPaging from "./lib/postPaging.mjs";
 import * as Cache from "./lib/cache.mjs";
 import * as Dates from "./lib/dates.mjs";
+import * as Markdown from "./lib/markdown.mjs";
 import * as Urls from "./lib/urls.mjs";
-export { PostQueries, PostFiltering, PostOrdering, PostPaging, Cache, Dates, Urls };
+export { PostQueries, PostFiltering, PostOrdering, PostPaging, Cache, Dates, Markdown, Urls };

package/index.mjs

@@ -4,6 +4,7 @@ import * as PostOrdering from './lib/postOrdering.mjs';
 import * as PostPaging from './lib/postPaging.mjs';
 import * as Cache from './lib/cache.mjs';
 import * as Dates from './lib/dates.mjs';
+import * as Markdown from './lib/markdown.mjs';
 import * as Urls from './lib/urls.mjs';
 
 export {
@@ -13,5 +14,6 @@ export {
     PostPaging,
     Cache,
     Dates,
+    Markdown,
     Urls
 };

package/lib/markdown.d.mts

@@ -0,0 +1,18 @@
+/**
+ * Converts markdown to HTML without wrapping in a <p>
+ * @param {string} markdown
+ * @returns {Promise<string>}
+ */
+export function getInlineHtmlFrom(markdown: string): Promise<string>;
+/**
+ * Converts markdown to HTML
+ * @param {string} markdown
+ * @returns {Promise<string>}
+ */
+export function getHtmlFrom(markdown: string): Promise<string>;
+/**
+ * Converts markdown to plain text
+ * @param {string} markdown
+ * @returns {Promise<string>}
+ */
+export function getTextFrom(markdown: string): Promise<string>;

package/lib/markdown.mjs

@@ -0,0 +1,45 @@
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkRehype from 'remark-rehype'
+import rehypeStringify from 'rehype-stringify';
+
+/**
+ * Converts markdown to HTML without wrapping in a <p>
+ * @param {string} markdown 
+ * @returns {Promise<string>}
+ */
+export async function getInlineHtmlFrom(markdown) {
+    let html = await getHtmlFrom(markdown);
+
+    // There may be a better way to unwrap this... maybe a visitor
+    if (html.substring(0, 3) == '<p>' && html.substring(html.length - 4) == '</p>') {
+        html = html.substring(3, html.length - 4);
+    }
+
+    return html;
+}
+
+/**
+ * Converts markdown to HTML
+ * @param {string} markdown 
+ * @returns {Promise<string>}
+ */
+export async function getHtmlFrom(markdown) {
+    const vfile = await unified()
+    .use(remarkParse)
+    .use(remarkRehype)
+    .use(rehypeStringify)
+    .process(markdown)
+
+    return String(vfile);
+}
+
+/**
+ * Converts markdown to plain text
+ * @param {string} markdown 
+ * @returns {Promise<string>}
+ */
+export async function getTextFrom(markdown) {
+    const html = await getInlineHtmlFrom(markdown);
+    return html.replace(/<.*?>/g, '');
+}

package/lib/postQueries.d.mts

@@ -27,9 +27,9 @@ export function getAuthorInfo(slug: string): Promise<AuthorInfo>;
  * Returns a list of breadcrumbs
  * @param {URL} currentUrl
  * @param {Site} site
- * @returns {NavPage[]}
+ * @returns {Promise<NavPage[]>}
  */
-export function getBreadcrumbs(currentUrl: URL, site: Site): NavPage[];
+export function getBreadcrumbs(currentUrl: URL, site: Site): Promise<NavPage[]>;
 /**
  * Converts a MarkdownInstance into a NavPage
  * @param {MarkdownInstance} page

package/lib/postQueries.mjs

@@ -144,7 +144,7 @@ export async function getAuthorInfo (slug) {
  * Returns a list of breadcrumbs
  * @param {URL} currentUrl 
  * @param {Site} site
- * @returns {NavPage[]}
+ * @returns {Promise<NavPage[]>}
  */
 export async function getBreadcrumbs (currentUrl, site) {
     const allPages = await getPages();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-accelerator-utils",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "description": "Astro utilities for Astro Accelerator.",
   "main": "index.mjs",
   "files": [
@@ -30,6 +30,10 @@
   "homepage": "https://astro.stevefenton.co.uk/",
   "devDependencies": {
     "@types/node": "^18.11.9",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.3",
+    "unified": "^10.1.2",
+    "remark-parse": "^10.0.1",
+    "remark-rehype": "^10.1.0",
+    "rehype-stringify": "^9.0.3"
   }
 }