@riebeckite/plugin-related-posts 0.0.24 → 0.0.26

package/dist/components/related-posts.d.ts

@@ -1,7 +1,8 @@
 import type { RelatedPostsEntry, ResolvedRelatedPostsOptions } from "../src/types.js";
 export type RelatedPostsProps = {
-    entries: readonly RelatedPostsEntry[];
-    options: ResolvedRelatedPostsOptions;
+    entries?: readonly RelatedPostsEntry[];
+    options?: ResolvedRelatedPostsOptions;
 };
-declare const RelatedPosts: (props: Readonly<RelatedPostsProps>) => import("hono/jsx/jsx-dev-runtime").JSX.Element;
+declare const RelatedPosts: (props: Readonly<RelatedPostsProps>) => Promise<import("hono/utils/html").HtmlEscapedString>;
+export declare function renderRelatedPostsContent(entries: readonly RelatedPostsEntry[], options: ResolvedRelatedPostsOptions): import("hono/utils/html").HtmlEscapedString | Promise<import("hono/utils/html").HtmlEscapedString>;
 export default RelatedPosts;

package/dist/components/related-posts.js

@@ -1,11 +1,116 @@
+// components/related-posts.tsx
+import { useArticleContext, useSiteContext } from "@riebeckite/ui";
+import { html } from "hono/html";
+
+// src/options.ts
+var DEFAULT_RELATED_POSTS_LIMIT = 5;
+var DEFAULT_RELATED_POSTS_MIN_SCORE = 1;
+var DEFAULT_RELATED_POSTS_HEADING_TEXT = "Related";
+var DEFAULT_RELATED_POSTS_CLASS_NAME = "rb-related-posts";
+function resolveRelatedPostsOptions(options = {}) {
+  return {
+    limit: options.limit ?? DEFAULT_RELATED_POSTS_LIMIT,
+    minScore: options.minScore ?? DEFAULT_RELATED_POSTS_MIN_SCORE,
+    heading: options.heading ?? true,
+    headingText: options.headingText ?? DEFAULT_RELATED_POSTS_HEADING_TEXT,
+    className: normalizeClassName(options.className),
+    useTags: options.useTags ?? true,
+    useBacklinks: options.useBacklinks ?? true
+  };
+}
+function normalizeClassName(className) {
+  if (typeof className !== "string") return DEFAULT_RELATED_POSTS_CLASS_NAME;
+  const trimmed = className.trim();
+  return trimmed === "" ? DEFAULT_RELATED_POSTS_CLASS_NAME : trimmed;
+}
+
+// src/related.ts
+var DIRECT_LINK_WEIGHT = 3;
+var SHARED_TAG_WEIGHT = 2;
+var CO_CITATION_WEIGHT = 1;
+var getRelatedPosts = ({ view, entry, options }) => {
+  const resolved = options ?? {
+    limit: 5,
+    minScore: 1,
+    useTags: true,
+    useBacklinks: true,
+    heading: true,
+    headingText: "Related posts",
+    className: "rr-related-posts"
+  };
+  const scores = /* @__PURE__ */ new Map();
+  const outgoing = new Set(
+    entry.links.flatMap(
+      (link) => link.kind === "note" && link.slug ? [link.slug] : []
+    )
+  );
+  if (resolved.useTags) {
+    for (const tag of entry.tags) {
+      for (const candidate of view.getDiscoverableEntriesByTag(tag)) {
+        if (candidate.slug !== entry.slug) {
+          addScore(scores, candidate.slug, SHARED_TAG_WEIGHT);
+        }
+      }
+    }
+  }
+  if (resolved.useBacklinks) {
+    for (const candidate of [
+      ...view.getDiscoverableOutgoing(entry.slug),
+      ...view.getDiscoverableIncoming(entry.slug)
+    ]) {
+      if (candidate.slug !== entry.slug) {
+        addScore(scores, candidate.slug, DIRECT_LINK_WEIGHT);
+      }
+    }
+  }
+  for (const target of outgoing) {
+    for (const candidate of view.getDiscoverableIncoming(target)) {
+      if (candidate.slug !== entry.slug) {
+        addScore(scores, candidate.slug, CO_CITATION_WEIGHT);
+      }
+    }
+  }
+  return [...scores].flatMap(([slug, score]) => {
+    const candidate = view.findDiscoverableBySlug(slug);
+    return candidate && score >= resolved.minScore ? [
+      {
+        slug,
+        permalink: candidate.permalink,
+        title: candidate.title,
+        score
+      }
+    ] : [];
+  }).sort(compareRelatedEntries).slice(0, resolved.limit);
+};
+function compareRelatedEntries(a, b) {
+  if (b.score !== a.score) return b.score - a.score;
+  const byTitle = a.title.localeCompare(b.title);
+  if (byTitle !== 0) return byTitle;
+  return a.slug.localeCompare(b.slug);
+}
+function addScore(scores, slug, weight) {
+  scores.set(slug, (scores.get(slug) ?? 0) + weight);
+}
+
 // components/related-posts.tsx
 import { jsx, jsxs } from "hono/jsx/jsx-runtime";
-var RelatedPosts = ((props) => {
-  if (props.entries.length === 0) return null;
-  const { className, heading, headingText } = props.options;
+var RelatedPosts = (async (props) => {
+  const site = useSiteContext();
+  const article = useArticleContext();
+  const options = props.options ?? resolveRelatedPostsOptions(findRelatedPostsOptions(site?.config.plugins));
+  const entries = props.entries ?? (site && article?.entry ? await getRelatedPosts({
+    view: site.view,
+    entry: article.entry,
+    options
+  }) : void 0);
+  return renderRelatedPostsContent(entries ?? [], options);
+});
+function renderRelatedPostsContent(entries, options) {
+  if (entries.length === 0) return html``;
+  const { className, heading, headingText } = options;
   return /* @__PURE__ */ jsxs("nav", { class: className, "data-related-posts": "", children: [
     heading ? /* @__PURE__ */ jsx("h2", { class: `${className}__heading`, children: headingText }) : null,
-    /* @__PURE__ */ jsx("ul", { children: props.entries.map((entry) => /* @__PURE__ */ jsx("li", { class: `${className}__item`, children: /* @__PURE__ */ jsx(
+    /* @__PURE__ */ jsx("ul", { children: entries.map((entry) => /* @__PURE__ */ jsx("li", { class: `${className}__item`, children: /* @__PURE__ */ jsx(
       "a",
       {
         class: `${className}__link`,
@@ -15,8 +120,12 @@ var RelatedPosts = ((props) => {
       }
     ) }, entry.slug)) })
   ] });
-});
+}
 var related_posts_default = RelatedPosts;
+function findRelatedPostsOptions(plugins) {
+  return plugins?.find((plugin) => plugin.name === "related-posts")?.options;
+}
 export {
-  related_posts_default as default
+  related_posts_default as default,
+  renderRelatedPostsContent
 };

package/dist/index.js

@@ -5,24 +5,8 @@ import {
 } from "@riebeckite/core";
 
 // components/related-posts.tsx
-import { jsx, jsxs } from "hono/jsx/jsx-runtime";
-var RelatedPosts = ((props) => {
-  if (props.entries.length === 0) return null;
-  const { className, heading, headingText } = props.options;
-  return /* @__PURE__ */ jsxs("nav", { class: className, "data-related-posts": "", children: [
-    heading ? /* @__PURE__ */ jsx("h2", { class: `${className}__heading`, children: headingText }) : null,
-    /* @__PURE__ */ jsx("ul", { children: props.entries.map((entry) => /* @__PURE__ */ jsx("li", { class: `${className}__item`, children: /* @__PURE__ */ jsx(
-      "a",
-      {
-        class: `${className}__link`,
-        href: entry.permalink,
-        "data-related-score": entry.score,
-        children: entry.title
-      }
-    ) }, entry.slug)) })
-  ] });
-});
-var related_posts_default = RelatedPosts;
+import { useArticleContext, useSiteContext } from "@riebeckite/ui";
+import { html } from "hono/html";
 
 // src/options.ts
 var DEFAULT_RELATED_POSTS_LIMIT = 5;
@@ -173,11 +157,45 @@ function addScore(scores, slug, weight) {
   scores.set(slug, (scores.get(slug) ?? 0) + weight);
 }
 
+// components/related-posts.tsx
+import { jsx, jsxs } from "hono/jsx/jsx-runtime";
+var RelatedPosts = (async (props) => {
+  const site = useSiteContext();
+  const article = useArticleContext();
+  const options = props.options ?? resolveRelatedPostsOptions(findRelatedPostsOptions(site?.config.plugins));
+  const entries = props.entries ?? (site && article?.entry ? await getRelatedPosts({
+    view: site.view,
+    entry: article.entry,
+    options
+  }) : void 0);
+  return renderRelatedPostsContent(entries ?? [], options);
+});
+function renderRelatedPostsContent(entries, options) {
+  if (entries.length === 0) return html``;
+  const { className, heading, headingText } = options;
+  return /* @__PURE__ */ jsxs("nav", { class: className, "data-related-posts": "", children: [
+    heading ? /* @__PURE__ */ jsx("h2", { class: `${className}__heading`, children: headingText }) : null,
+    /* @__PURE__ */ jsx("ul", { children: entries.map((entry) => /* @__PURE__ */ jsx("li", { class: `${className}__item`, children: /* @__PURE__ */ jsx(
+      "a",
+      {
+        class: `${className}__link`,
+        href: entry.permalink,
+        "data-related-score": entry.score,
+        children: entry.title
+      }
+    ) }, entry.slug)) })
+  ] });
+}
+var related_posts_default = RelatedPosts;
+function findRelatedPostsOptions(plugins) {
+  return plugins?.find((plugin) => plugin.name === "related-posts")?.options;
+}
+
 // src/render.ts
 import { renderToString } from "hono/jsx/dom/server";
 var RELATED_POSTS_ATTRIBUTE = "data-related-posts";
 function renderRelatedPosts(entries, options) {
-  return renderToString(related_posts_default({ entries, options }));
+  return renderToString(renderRelatedPostsContent(entries, options));
 }
 
 // index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-related-posts",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -22,11 +22,12 @@
   },
   "dependencies": {
     "hono": "^4.12.25",
-    "@riebeckite/core": "0.0.24"
+    "@riebeckite/core": "0.0.26",
+    "@riebeckite/ui": "0.0.26"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.24"
+    "@riebeckite/test": "0.0.26"
   },
   "publishConfig": {
     "access": "public"