@riebeckite/plugin-backlinks 0.0.22 → 0.0.23

package/README.md

@@ -8,13 +8,13 @@ current note.
 [日本語](./README_ja.md)
 
 ## Recommended placement
-
-`backlinksPlugin()` automatically appends a footer list of incoming links to
-the `article.footer` semantic body slot. The Site owns physical placement: it
-displays the list only where it renders that slot, normally once after article
-content. `getPublishedBacklinks()` resolves the incoming links of a note from
-the content manifest, keeps only publicly discoverable notes, and returns them
-sorted in manifest order.
+`backlinksPlugin()` provides a `getBacklinks({ view, slug })` helper that returns
+`readonly ArticleBacklink[]` (`{ slug, permalink, title }`) and a `<Backlinks
+backlinks={...} />` component that renders a `<footer class="rr-backlinks">` with
+an eyebrow label and a list of links. The Site places the `<Backlinks />`
+component itself, normally once after article content. `getBacklinks()` resolves
+the incoming links of a note from the content manifest, keeps only publicly
+discoverable notes, and returns them sorted in manifest order.
 
 Without incoming links (or when none of them are published), the component
 renders nothing.
@@ -33,47 +33,33 @@ export default defineConfig({
 
 `backlinksPlugin()` adds backlinks for every public entry with published
 incoming links and bundles `style.css` into the app stylesheet. Render
-`<ContentSlot slots={bodySlots} name="article.footer" />` once in the article
-layout to display it. The official Starter already renders this slot.
+`<Backlinks backlinks={getBacklinks({ view, slug })} />` once in the article
+layout to display it. The official Starter already renders this component.
 
 ## Advanced customization
 
-To choose a different location, prevent the automatic slot contribution with
-`render: false`; this does not change backlink data or its publication
-filtering. Resolve the data in the Site route and render the public component
-exactly once:
+To place the component in a custom location, call `getBacklinks({ view, slug })`
+in the Site route and render the `<Backlinks backlinks={...} />` component exactly
+once. The data resolver does not change backlink data or its publication
+filtering.
 
 ```tsx
-import Backlinks, { getPublishedBacklinks } from "@riebeckite/plugin-backlinks";
+import Backlinks, { getBacklinks } from "@riebeckite/plugin-backlinks";
 import { content } from "virtual:riebeckite/content";
 import { getArticleTitle } from "../lib/article-title";
 
 const manifest = await content.getManifest();
-const backlinks = getPublishedBacklinks({
-  manifest,
-  config,
-  slug,
-  resolveTitle: getArticleTitle,
-});
+const backlinks = getBacklinks({ view, slug, resolveTitle: getArticleTitle });
 
 return (
   <aside><Backlinks backlinks={backlinks} /></aside>
 );
 ```
 
-```ts
-plugins: [backlinksPlugin({ render: false })];
-```
-
-Remove the component to remove manually placed UI. Do not render both this
-component and `article.footer` with automatic rendering enabled, or it will
-appear twice.
-
 ## Configuration
 
-| Option | Type | Default | Description |
-| --- | --- | --- | --- |
-| `render` | `boolean` | `true` | Append the generated list to `article.footer`. Set `false` for manual placement. |
+There are no plugin options for `backlinksPlugin`. The `Backlinks` component
+accepts `backlinks` as a required prop.
 
 ## Component
 
@@ -84,8 +70,8 @@ an eyebrow label and a list of links to each backlink's resolved `permalink`.
 
 - `backlinksPlugin()` — plugin factory
 - `Backlinks` — list component (default export of `components/backlinks.tsx`)
-- `getPublishedBacklinks({ manifest, config, slug, resolveTitle })` — resolves
-  published backlinks for a slug
+- `getBacklinks({ view, slug })` — resolves published backlinks for a slug
+  (`{ slug, permalink, title }` each)
 - Type: `ArticleBacklink` (`{ slug, permalink, title }`)
 
 ## See also

package/README_ja.md

@@ -8,7 +8,7 @@
 
 ## 推奨配置
 
-`backlinksPlugin()` はコンテンツマニフェストから被リンクを集め、公開対象のノートだけをマニフェスト順で `article.footer` body slot に自動追加します。物理的な配置は Site が所有し、通常は記事本文の後でこの slot を一度描画します。`Backlinks` コンポーネントはその結果をリンク一覧として描画します。表示対象がなければ何も出力しません。
+`backlinksPlugin()` はコンテンツマニフェストから被リンクを集め、公開対象のノートだけをマニフェスト順で `<Backlinks backlinks={getBacklinks({ view, slug })} />` へ渡します。物理的な配置は Site が所有し、通常は記事本文の後でこのコンポーネントを一度描画します。`Backlinks` コンポーネントはその結果をリンク一覧として描画します。表示対象がなければ何も出力しません。
 
 ## クイックスタート
 
@@ -22,38 +22,32 @@ export default defineConfig({
 });
 ```
 
-プラグインは公開済みの被リンクがある記事へ自動的に出力を追加します。記事レイアウトで `<ContentSlot slots={bodySlots} name="article.footer" />` を一度描画してください。公式 Starter はこの slot をすでに描画しています。
+プラグインは公開済みの被リンクがある記事へ自動的に出力を追加します。記事レイアウトで `<Backlinks backlinks={getBacklinks({ view, slug })} />` を一度描画してください。公式 Starter はこのコンポーネントをすでに描画しています。
 
 ## 高度なカスタマイズ
 
-アプリ側で表示位置を決める場合は、`render: false` で自動 slot 追加を止めます。データの生成と公開境界のフィルタリングは維持されます。記事ルートなどでマニフェストを取得し、現在の `slug` に対する被リンクを渡してください。
+アプリ側で表示位置を決める場合は、`getBacklinks({ view, slug })` を呼び出してデータを取得し、 `<Backlinks backlinks={...} />` コンポーネントを一度だけ描画してください。データの生成と公開境界のフィルタリングは維持されます。
 
 ```tsx
-import Backlinks, { getPublishedBacklinks } from "@riebeckite/plugin-backlinks";
+import Backlinks, { getBacklinks } from "@riebeckite/plugin-backlinks";
 
 const manifest = await content.getManifest();
-const items = getPublishedBacklinks({ manifest, config, slug, resolveTitle });
+const items = getBacklinks({ manifest, config, slug, resolveTitle });
 
 return <Article footerContent={<Backlinks backlinks={items} />} />;
 ```
 
-```ts
-plugins: [backlinksPlugin({ render: false })];
-```
-
 手動配置を消すにはコンポーネントを消します。自動描画を有効にしたまま同じコンポーネントを描画すると重複します。
 
 ## 設定
 
-| オプション | 型 | 既定値 | 説明 |
-| --- | --- | --- | --- |
-| `render` | `boolean` | `true` | `article.footer` への自動追加。手動配置では `false`。 |
+`backlinksPlugin()` にはプラグイン用のオプションがありません。`Backlinks` コンポーネントは `backlinks` 必須プロップを受け取ります。
 
 ## 公開 API
 
 - `backlinksPlugin()` — プラグインファクトリ
 - `Backlinks` — 被リンク一覧コンポーネント
-- `getPublishedBacklinks({ manifest, config, slug, resolveTitle })` — 公開済みの被リンクを解決する関数
+- `getBacklinks({ view, slug })` — 公開済みの被リンクを解決する関数
 - `ArticleBacklink` — `{ slug, permalink, title }` の型。`permalink` は解決済みの canonical URL
 
 ## 関連資料

package/dist/components/backlinks.d.ts

@@ -1,6 +1,6 @@
 import type { ArticleBacklink } from "../src/backlinks.js";
-type Props = {
-    backlinks: ArticleBacklink[];
+export type BacklinksProps = {
+    backlinks: readonly ArticleBacklink[];
 };
-export default function Backlinks(props: Props): import("hono/jsx/jsx-dev-runtime").JSX.Element;
-export {};
+declare const Backlinks: (props: Readonly<BacklinksProps>) => import("hono/jsx/jsx-dev-runtime").JSX.Element;
+export default Backlinks;

package/dist/components/backlinks.js

@@ -1,12 +1,13 @@
 // components/backlinks.tsx
 import { jsx, jsxs } from "hono/jsx/jsx-runtime";
-function Backlinks(props) {
+var Backlinks = ((props) => {
   if (props.backlinks.length === 0) return null;
   return /* @__PURE__ */ jsxs("footer", { class: "rr-backlinks", children: [
     /* @__PURE__ */ jsx("p", { class: "rr-backlinks__eyebrow", children: "Backlinks" }),
     /* @__PURE__ */ jsx("ul", { class: "rr-backlinks__list", children: props.backlinks.map((backlink) => /* @__PURE__ */ jsx("li", { class: "rr-backlinks__item", children: /* @__PURE__ */ jsx("a", { class: "rr-backlinks__link", href: backlink.permalink, children: backlink.title }) }, backlink.slug)) })
   ] });
-}
+});
+var backlinks_default = Backlinks;
 export {
-  Backlinks as default
+  backlinks_default as default
 };

package/dist/index.d.ts

@@ -1,7 +1,6 @@
+export type { BacklinksProps } from "./components/backlinks.js";
 export { default as Backlinks } from "./components/backlinks.js";
 export type { ArticleBacklink } from "./src/backlinks.js";
-export { getPublishedBacklinks } from "./src/backlinks.server.js";
-export type BacklinksOptions = {
-    render?: boolean;
-};
+export { getBacklinks, getPublishedBacklinks } from "./src/backlinks.server.js";
+export type BacklinksOptions = Record<never, never>;
 export declare function backlinksPlugin(options?: BacklinksOptions): import("@riebeckite/core").RiebeckitePlugin<BacklinksOptions>;

package/dist/index.js

@@ -1,19 +1,16 @@
 // index.ts
-import {
-  appendContentBodySlot,
-  definePlugin
-} from "@riebeckite/core";
-import { renderToString } from "hono/jsx/dom/server";
+import { definePlugin } from "@riebeckite/core";
 
 // components/backlinks.tsx
 import { jsx, jsxs } from "hono/jsx/jsx-runtime";
-function Backlinks(props) {
+var Backlinks = ((props) => {
   if (props.backlinks.length === 0) return null;
   return /* @__PURE__ */ jsxs("footer", { class: "rr-backlinks", children: [
     /* @__PURE__ */ jsx("p", { class: "rr-backlinks__eyebrow", children: "Backlinks" }),
     /* @__PURE__ */ jsx("ul", { class: "rr-backlinks__list", children: props.backlinks.map((backlink) => /* @__PURE__ */ jsx("li", { class: "rr-backlinks__item", children: /* @__PURE__ */ jsx("a", { class: "rr-backlinks__link", href: backlink.permalink, children: backlink.title }) }, backlink.slug)) })
   ] });
-}
+});
+var backlinks_default = Backlinks;
 
 // src/backlinks.server.ts
 function getPublishedBacklinks(args) {
@@ -32,6 +29,11 @@ function getPublishedBacklinks(args) {
     (backlink) => backlink !== null
   );
 }
+var getBacklinks = ({ view, slug }) => view.getDiscoverableIncoming(slug).map((entry) => ({
+  slug: entry.slug,
+  permalink: entry.permalink,
+  title: entry.title || entry.slug
+}));
 
 // index.ts
 function backlinksPlugin(options = {}) {
@@ -39,25 +41,6 @@ function backlinksPlugin(options = {}) {
     name: "backlinks",
     order: 500,
     options,
-    validateOptions: validateBacklinksOptions,
-    onManifestCreated: ({ config, manifest }) => {
-      if (options.render === false) return;
-      if (!config) return;
-      for (const entry of manifest.discoverableEntries) {
-        const backlinks = getPublishedBacklinks({
-          manifest,
-          config,
-          slug: entry.slug,
-          resolveTitle
-        });
-        if (backlinks.length === 0) continue;
-        appendContentBodySlot(
-          entry,
-          "article.footer",
-          renderToString(Backlinks({ backlinks }))
-        );
-      }
-    },
     assets: [
       {
         pluginName: "backlinks",
@@ -67,18 +50,9 @@ function backlinksPlugin(options = {}) {
     ]
   });
 }
-function validateBacklinksOptions(options) {
-  if (!options || options.render === void 0 || typeof options.render === "boolean") {
-    return [];
-  }
-  return [{ path: "render", message: "Expected a boolean." }];
-}
-function resolveTitle(slug, title) {
-  if (typeof title === "string" && title.trim()) return title;
-  return slug.split("/").at(-1) ?? slug;
-}
 export {
-  Backlinks,
+  backlinks_default as Backlinks,
   backlinksPlugin,
+  getBacklinks,
   getPublishedBacklinks
 };

package/dist/src/backlinks.server.d.ts

@@ -1,4 +1,4 @@
-import type { ContentManifest, ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { ContentManifest, PluginDataHelper, PublicContentView, ResolvedRiebeckiteConfig } from "@riebeckite/core";
 import type { ArticleBacklink } from "./backlinks.js";
 type TitleResolver = (slug: string, title: unknown) => string;
 export declare function getPublishedBacklinks(args: {
@@ -7,4 +7,8 @@ export declare function getPublishedBacklinks(args: {
     slug: string;
     resolveTitle: TitleResolver;
 }): ArticleBacklink[];
+export declare const getBacklinks: PluginDataHelper<{
+    view: PublicContentView;
+    slug: string;
+}, readonly ArticleBacklink[]>;
 export {};

package/package.json

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