@riebeckite/plugin-related-posts 0.0.14 → 0.0.15

package/README.md

@@ -21,8 +21,9 @@ Candidates are sorted by score (descending), then by title, then by slug, and
 clamped to `limit`. Entries that score below `minScore` are dropped. When no
 candidate qualifies, the entry's HTML is left untouched.
 
-The plugin updates both `entry.html` and the cached `PostContent.html` that the
-content route renders, so the section appears on generated pages and in feeds.
+The plugin appends the section to the manifest entry's HTML. Core synchronizes
+that HTML with the content the route renders, so the section appears on generated
+pages and in feeds.
 
 ## Usage
 
@@ -94,4 +95,5 @@ import "@riebeckite/plugin-related-posts/style.css";
 
 ## See also
 
-- [Plugin guide](../../../docs/en/reference/plugin-api.md)
+- [Plugin guide](../../../docs/en/docs/reference/plugin-api.md)
+

package/README_ja.md

@@ -15,15 +15,15 @@
 | シグナル | 重み | 意味 |
 | -------- | ---- | ---- |
 | 直接リンク | 3 | 現在のエントリが候補へ、または候補が現在のエントリへリンクしている |
-| タグの共有 | 共通タグ1件につき2 | 現在のエントリと候補が同じタグを持つ |
-| 共引用 | 共通リンク先1件につき1 | 両方のエントリが同じノートへリンクしている |
+| タグの共有 | 共通タグ 1 件につき 2 | 現在のエントリと候補が同じタグを持つ |
+| 共引用 | 共通リンク先 1 件につき 1 | 両方のエントリが同じノートへリンクしている |
 
 候補はスコアの降順、同点ならタイトル、さらに同点ならスラッグの順に並べ、
 `limit` 件に絞ります。`minScore` 未満の候補は除外します。条件を満たす候補が
-1件もない場合、そのエントリの HTML は変更しません。
+1 件もない場合、そのエントリの HTML は変更しません。
 
-`entry.html` と、コンテンツルートが描画するキャッシュ済みの
-`PostContent.html` の両方を更新するため、生成ページとフィードの両方に
+マニフェストエントリの HTML にセクションを追記します。Core がその HTML を
+コンテンツルートの描画 HTML と同期するため、生成ページとフィードの両方に
 セクションが反映されます。
 
 ## 使い方
@@ -96,4 +96,5 @@ import "@riebeckite/plugin-related-posts/style.css";
 
 ## ????
 
-- [?????????](../../../docs/ja/reference/plugin-api.md)
+- [?????????](../../../docs/ja/docs/reference/plugin-api.md)
+

package/dist/index.d.ts

@@ -8,9 +8,8 @@ export declare const RELATED_POSTS_PLUGIN_NAME = "related-posts";
  * Build-time "related notes" navigation.
  *
  * For every published entry it ranks the other entries in the manifest, then
- * appends a `<nav>` section to both `entry.html` and the cached
- * `PostContent.html` that the content route renders. No client runtime is
- * required.
+ * appends a `<nav>` section to the manifest entry HTML, which is the final
+ * rendering source. No client runtime is required.
  */
 export declare function relatedPosts(options?: RelatedPostsOptions): import("@riebeckite/core").RiebeckitePlugin<RelatedPostsOptions>;
 /** Alias matching the `*Plugin` suffix used by other plugin factories. */

package/dist/index.js

@@ -27,9 +27,6 @@ function normalizeClassName(className) {
 }
 
 // src/related.ts
-import {
-  isPublished
-} from "@riebeckite/core";
 var DIRECT_LINK_WEIGHT = 3;
 var SHARED_TAG_WEIGHT = 2;
 var CO_CITATION_WEIGHT = 1;
@@ -77,10 +74,11 @@ function buildRelatedPosts(args) {
   candidates.sort(compareRelatedEntries);
   return candidates.slice(0, options.limit);
 }
-function isEligibleRelatedEntry(entry, manifest, config) {
+function isEligibleRelatedEntry(entry, manifest, _config) {
   if (manifest.redirects.has(entry.permalink)) return false;
-  if (config) return isPublished(config, entry.frontmatter);
-  return entry.frontmatter.private !== true && entry.frontmatter.draft !== true && entry.frontmatter.publish !== false;
+  return manifest.discoverableEntries.some(
+    (candidate) => candidate.slug === entry.slug
+  );
 }
 function compareRelatedEntries(a, b) {
   if (b.score !== a.score) return b.score - a.score;
@@ -120,17 +118,18 @@ function renderRelatedPosts(entries, options) {
 var RELATED_POSTS_PLUGIN_NAME = "related-posts";
 function relatedPosts(options = {}) {
   const resolved = resolveRelatedPostsOptions(options);
-  const processed = /* @__PURE__ */ new Map();
   return definePlugin({
     name: RELATED_POSTS_PLUGIN_NAME,
+    processedContentCache: {
+      version: "related-posts-v1",
+      dependencyMode: "none"
+    },
+    outputDependencies: [{ type: "global" }],
     options,
     validateOptions: validateRelatedPostsOptions,
-    onPostProcessed: (context) => {
-      processed.set(context.slug, context.content);
-    },
     onManifestCreated: (context) => {
       const { manifest } = context;
-      for (const entry of manifest.entries) {
+      for (const entry of manifest.discoverableEntries) {
         if (entry.html.includes(RELATED_POSTS_ATTRIBUTE)) continue;
         if (!isEligibleRelatedEntry(entry, manifest, context.config)) continue;
         const related = buildRelatedPosts({
@@ -141,10 +140,7 @@ function relatedPosts(options = {}) {
         });
         if (related.length === 0) continue;
         entry.html = `${entry.html}${renderRelatedPosts(related, resolved)}`;
-        const content = processed.get(entry.slug);
-        if (content) content.html = entry.html;
       }
-      processed.clear();
     },
     assets: [createStyleAsset(RELATED_POSTS_PLUGIN_NAME)]
   });

package/dist/src/related.d.ts

@@ -1,4 +1,4 @@
-import { type ContentManifest, type ContentManifestEntry, type ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { ContentManifest, ContentManifestEntry, ResolvedRiebeckiteConfig } from "@riebeckite/core";
 import type { RelatedPostsEntry, ResolvedRelatedPostsOptions } from "./types.js";
 /**
  * Weights are deterministic constants: the same manifest always produces the
@@ -18,14 +18,14 @@ export type BuildRelatedPostsArgs = {
     config?: ResolvedRiebeckiteConfig;
 };
 /**
- * Ranks the published entries related to `entry` using the manifest's content
- * graph. Pure build-time computation: it only reads `byTag`, `outgoingLinks`,
- * `incomingLinks`, `redirects`, and `bySlug`.
+ * Ranks the discoverable entries related to `entry` using the manifest's
+ * content graph. Pure build-time computation: it only reads manifest indexes
+ * and the Core-resolved publishing view.
  */
 export declare function buildRelatedPosts(args: BuildRelatedPostsArgs): RelatedPostsEntry[];
 /**
  * An entry may receive a related-posts section (and be offered as a related
- * candidate) only when it is published and its canonical permalink is not
- * shadowed by a redirect. Unpublished and redirect-only entries are skipped.
+ * candidate) only when it is discoverable and its canonical permalink is not
+ * shadowed by a redirect. Hidden and redirect-only entries are skipped.
  */
-export declare function isEligibleRelatedEntry(entry: ContentManifestEntry, manifest: ContentManifest, config?: ResolvedRiebeckiteConfig): boolean;
+export declare function isEligibleRelatedEntry(entry: ContentManifestEntry, manifest: ContentManifest, _config?: ResolvedRiebeckiteConfig): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-related-posts",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,11 +15,11 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.14"
+    "@riebeckite/core": "0.0.15"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.14"
+    "@riebeckite/test": "0.0.15"
   },
   "publishConfig": {
     "access": "public"