astro-accelerator-utils 0.0.31 → 0.0.33

package/index.d.mts

@@ -1,7 +1,9 @@
 import * as PostQueries from "./lib/postQueries.mjs";
 import * as PostFiltering from "./lib/postFiltering.mjs";
 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, Cache, Dates, Urls };
+export { PostQueries, PostFiltering, PostOrdering, PostPaging, Cache, Dates, Markdown, Urls };

package/index.mjs

@@ -1,15 +1,19 @@
-import * as PostQueries from "./lib/postQueries.mjs";
-import * as PostFiltering from "./lib/postFiltering.mjs";
-import * as PostOrdering from "./lib/postOrdering.mjs";
-import * as Cache from "./lib/cache.mjs";
-import * as Dates from "./lib/dates.mjs";
-import * as Urls from "./lib/urls.mjs";
+import * as PostQueries from './lib/postQueries.mjs';
+import * as PostFiltering from './lib/postFiltering.mjs';
+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,
+    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/postPaging.d.mts

@@ -0,0 +1,13 @@
+/**
+ * @typedef { import("../types/Link").Link } Link
+ */
+/**
+ * Provides a list of paging links, 1 ... 3 4 5 ... 7
+ * @param {number} limit
+ * @param {number} numberOfPages
+ * @param {number} currentPage
+ * @param {string} url
+ * @returns {Link[]}
+ */
+export function getPageLinks(limit: number, numberOfPages: number, currentPage: number, url: string): Link[];
+export type Link = import("../types/Link").Link;

package/lib/postPaging.mjs

@@ -0,0 +1,77 @@
+/**
+ * @typedef { import("../types/Link").Link } Link
+ */
+
+/**
+ * Provides a list of paging links, 1 ... 3 4 5 ... 7
+ * @param {number} limit 
+ * @param {number} numberOfPages 
+ * @param {number} currentPage 
+ * @param {string} url 
+ * @returns {Link[]}
+ */
+export function getPageLinks(limit, numberOfPages, currentPage, url) {
+    /** @type {Link[]} */
+    const pageLinks = [];
+  
+    let start = 0;
+    let end = numberOfPages;
+  
+    if (numberOfPages > limit) {
+      start = (currentPage - (limit - 1) / 2) - 1;
+      if (start < 0) {
+        start = 0;
+      }
+  
+      end = (start + limit);
+      if (end > numberOfPages) {
+        end = numberOfPages;
+        start = numberOfPages - limit;
+      }
+    }
+  
+    if (start == 1) {
+      pageLinks.push({
+        title: '1',
+        url: url.replace('/' + currentPage, '/' + 1),
+        ariaCurrent: false,
+        class: ''
+      });
+    } else if (start > 1) {
+      pageLinks.push({
+        title: '1',
+        url: url.replace('/' + currentPage, '/' + 1),
+        ariaCurrent: false,
+        class: 'paging-collapse-after'
+      });
+    }
+  
+    for (let i = start; i < end; i++) {
+      const userPage = i + 1;
+      pageLinks.push({
+        title: userPage.toString(),
+        url: url.replace('/' + currentPage, '/' + userPage),
+        ariaCurrent: userPage == currentPage ? 'page' : false,
+        class: ''
+      });
+    }
+  
+    if (end < (numberOfPages - 1)) {
+      pageLinks.push({
+        title: numberOfPages.toString(),
+        url: url.replace('/' + currentPage, '/' + numberOfPages),
+        ariaCurrent: false,
+        class: 'paging-collapse-before'
+      });
+    } else if (end < numberOfPages) {
+      pageLinks.push({
+        title: numberOfPages.toString(),
+        url: url.replace('/' + currentPage, '/' + numberOfPages),
+        ariaCurrent: false,
+        class: ''
+      });
+    }
+  
+    return pageLinks;
+}
+  

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.31",
+  "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"
   }
 }

package/types/Link.d.ts

@@ -0,0 +1,6 @@
+export interface Link {
+    title: string;
+    url: string;
+    ariaCurrent: 'page' | false;
+    class: string;
+}