@riebeckite/plugin-series 0.0.21 → 0.0.23

package/README.md

@@ -1,5 +1,7 @@
 # @riebeckite/plugin-series
 
+<!-- Generated from docs/docs/plugins/series.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 Ordered multi-part posts ("series") for Riebeckite. At build time, notes that
 share a series name get the same generated navigation listing every part in
 order, with the current part marked and previous/next links.
@@ -65,32 +67,9 @@ the numbered parts, using `date`/`created`/`published`, then `title`, then
 | `positionLabel` | `boolean` | `false` | Add a `Part N of M` label for the current note. |
 | `basePath` | `string` | `"/series"` | Base path for the generated pages. An empty string disables them. |
 
-## Output
-
-Each note in a series of two or more parts gets the following block appended to
-its HTML:
-
-```html
-<nav class="rb-series" data-series="Build a thing"
-     aria-label="Series navigation">
-  <p class="rb-series__title">
-    <a class="rb-series__link" href="/build-a-thing">Build a thing</a>
-  </p>
-  <ol class="rb-series__list">
-    <li class="rb-series__item">
-      <a class="rb-series__link" href="/part-1" data-series-order="1">Part 1</a>
-    </li>
-    <li class="rb-series__item">
-      <a class="rb-series__link" href="/part-2" data-series-order="2"
-         aria-current="page">Part 2</a>
-    </li>
-  </ol>
-  <div class="rb-series__nav">
-    <a class="rb-series__prev" rel="prev" href="/part-1">&larr; Part 1</a>
-    <a class="rb-series__next" rel="next" href="/part-3">Part 3 &rarr;</a>
-  </div>
-</nav>
-```
+## Display
+
+Each note in a series of two or more parts receives live series navigation after its article. The links and current position are calculated from the frontmatter shown above.
 
 All text and attributes are escaped. The injected HTML is written back to both
 the manifest entry and the processed content object so the page route, feeds,
@@ -171,5 +150,4 @@ matched with `.rb-series__item a[aria-current="page"]`.
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
-
+- [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)

package/README_ja.md

@@ -1,5 +1,7 @@
 # @riebeckite/plugin-series
 
+<!-- Generated from docs/docs/plugins/series.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 連載記事（シリーズ）を順番どおりに並べ、各記事へ共通のナビゲーションを差し込むプラグインです。ビルド時に、同じシリーズ名を持つノートをまとめて、目次・現在位置・前後の記事リンクを生成します。
 
 [English](./README.md)
@@ -54,31 +56,9 @@ series_order: 2
 | `positionLabel` | `boolean` | `false` | 現在の記事に「Part N of M」を付ける。 |
 | `basePath` | `string` | `"/series"` | 生成するページの基準パス。空文字にすると生成しない。 |
 
-## 出力
-
-2 件以上あるシリーズの各ノートには、次のブロックが HTML の末尾に追加されます。
-
-```html
-<nav class="rb-series" data-series="何かを作る"
-     aria-label="Series navigation">
-  <p class="rb-series__title">
-    <a class="rb-series__link" href="/part-1">何かを作る</a>
-  </p>
-  <ol class="rb-series__list">
-    <li class="rb-series__item">
-      <a class="rb-series__link" href="/part-1" data-series-order="1">導入編</a>
-    </li>
-    <li class="rb-series__item">
-      <a class="rb-series__link" href="/part-2" data-series-order="2"
-         aria-current="page">実装編</a>
-    </li>
-  </ol>
-  <div class="rb-series__nav">
-    <a class="rb-series__prev" rel="prev" href="/part-1">&larr; 導入編</a>
-    <a class="rb-series__next" rel="next" href="/part-3">仕上げ編 &rarr;</a>
-  </div>
-</nav>
-```
+## 表示
+
+2 件以上あるシリーズの各ノートには、記事の下にシリーズナビゲーションが実際に描画されます。リンクと現在位置は、上の frontmatter から計算します。
 
 テキストと属性はすべてエスケープします。生成した HTML は manifest の entry と処理済みコンテンツの両方へ書き戻すため、ページのルート表示・フィード・検索でも同じマークアップになります。
 
@@ -144,5 +124,4 @@ const html = renderSeriesIndex(manifest, "何かを作る");
 
 ## 関連
 
-- [プラグインガイド](../../../docs/docs/reference/plugin-api.ja.md)
-
+- [プラグインガイド](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md)

package/dist/components/series-navigation.d.ts

@@ -0,0 +1,9 @@
+import type { ResolvedSeriesOptions, SeriesIndex } from "../src/types.js";
+export type SeriesNavigationProps = {
+    index: SeriesIndex | null;
+    currentSlug: string;
+    className?: string;
+    options?: Pick<ResolvedSeriesOptions, "heading" | "positionLabel">;
+};
+declare const SeriesNavigation: ({ index, currentSlug, className, options, }: Readonly<SeriesNavigationProps>) => import("hono/jsx/jsx-dev-runtime").JSX.Element;
+export default SeriesNavigation;

package/dist/components/series-navigation.js

@@ -0,0 +1,54 @@
+// components/series-navigation.tsx
+import { jsx, jsxs } from "hono/jsx/jsx-runtime";
+var SeriesNavigation = (({
+  index,
+  currentSlug,
+  className = "rb-series",
+  options
+}) => {
+  if (!index || index.members.length === 0) return null;
+  const position = index.members.findIndex(
+    (member) => member.slug === currentSlug
+  );
+  const previous = position > 0 ? index.members[position - 1] : void 0;
+  const next = position >= 0 && position < index.members.length - 1 ? index.members[position + 1] : void 0;
+  const heading = options?.heading ?? true;
+  const positionLabel = options?.positionLabel ?? false;
+  return /* @__PURE__ */ jsxs(
+    "nav",
+    {
+      class: className,
+      "data-series": index.name,
+      "aria-label": "Series navigation",
+      children: [
+        heading ? /* @__PURE__ */ jsxs("p", { class: `${className}__title`, children: [
+          /* @__PURE__ */ jsx("a", { class: `${className}__link`, href: index.members[0].permalink, children: index.title }),
+          positionLabel && position >= 0 ? /* @__PURE__ */ jsx("span", { class: `${className}__position`, children: ` Part ${position + 1} of ${index.members.length}` }) : null
+        ] }) : null,
+        /* @__PURE__ */ jsx("ol", { class: `${className}__list`, children: index.members.map((member) => /* @__PURE__ */ jsx("li", { class: `${className}__item`, children: /* @__PURE__ */ jsx(
+          "a",
+          {
+            class: `${className}__link`,
+            href: member.permalink,
+            "aria-current": member.slug === currentSlug ? "page" : void 0,
+            children: member.title
+          }
+        ) }, member.slug)) }),
+        /* @__PURE__ */ jsxs("div", { class: `${className}__nav`, children: [
+          previous ? /* @__PURE__ */ jsxs("a", { class: `${className}__prev`, href: previous.permalink, rel: "prev", children: [
+            "← ",
+            previous.title
+          ] }) : null,
+          next ? /* @__PURE__ */ jsxs("a", { class: `${className}__next`, href: next.permalink, rel: "next", children: [
+            next.title,
+            " →"
+          ] }) : null
+        ] })
+      ]
+    }
+  );
+});
+var series_navigation_default = SeriesNavigation;
+export {
+  series_navigation_default as default
+};

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { resolveSeriesOptions } from "./src/series.js";
 import type { SeriesOptions } from "./src/types.js";
-export { buildSeriesIndex, collectSeriesIndexes, DEFAULT_SERIES_BASE_PATH, renderSeriesIndex, renderSeriesList, renderSeriesNavigation, seriesLandingPath, seriesSlug, } from "./src/series.js";
+export type { SeriesNavigationProps } from "./components/series-navigation.js";
+export { default as SeriesNavigation } from "./components/series-navigation.js";
+export { buildSeriesIndex, collectSeriesIndexes, DEFAULT_SERIES_BASE_PATH, getSeriesNavigation, renderSeriesIndex, renderSeriesList, renderSeriesNavigation, seriesLandingPath, seriesSlug, } from "./src/series.js";
 export type { ResolvedSeriesOptions, SeriesIndex, SeriesMember, SeriesOptions, } from "./src/types.js";
 /**
  * Series (ordered multi-part posts) for Riebeckite.

package/dist/index.js

@@ -1,6 +1,5 @@
 // index.ts
 import {
-  appendContentBodySlot,
   createStyleAsset,
   definePlugin
 } from "@riebeckite/core";
@@ -50,6 +49,13 @@ function buildSeriesIndex(manifest, name, options = {}) {
     (index) => index.name === name
   ) ?? null;
 }
+var getSeriesNavigation = ({ view, entry, index }) => {
+  if (!index || !view.findDiscoverableBySlug(entry.slug)) return null;
+  const members = index.members.filter(
+    (member) => view.findDiscoverableBySlug(member.slug)
+  );
+  return members.some((member) => member.slug === entry.slug) ? { ...index, members } : null;
+};
 function seriesSlug(name) {
   return name.split("/").map((segment) => {
     const normalized = segment.trim().toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
@@ -284,6 +290,58 @@ function normalizeBasePath(value) {
   return prefixed.length > 1 ? prefixed.replace(/\/+$/, "") : prefixed;
 }
 
+// components/series-navigation.tsx
+import { jsx, jsxs } from "hono/jsx/jsx-runtime";
+var SeriesNavigation = (({
+  index,
+  currentSlug,
+  className = "rb-series",
+  options
+}) => {
+  if (!index || index.members.length === 0) return null;
+  const position = index.members.findIndex(
+    (member) => member.slug === currentSlug
+  );
+  const previous = position > 0 ? index.members[position - 1] : void 0;
+  const next = position >= 0 && position < index.members.length - 1 ? index.members[position + 1] : void 0;
+  const heading = options?.heading ?? true;
+  const positionLabel = options?.positionLabel ?? false;
+  return /* @__PURE__ */ jsxs(
+    "nav",
+    {
+      class: className,
+      "data-series": index.name,
+      "aria-label": "Series navigation",
+      children: [
+        heading ? /* @__PURE__ */ jsxs("p", { class: `${className}__title`, children: [
+          /* @__PURE__ */ jsx("a", { class: `${className}__link`, href: index.members[0].permalink, children: index.title }),
+          positionLabel && position >= 0 ? /* @__PURE__ */ jsx("span", { class: `${className}__position`, children: ` Part ${position + 1} of ${index.members.length}` }) : null
+        ] }) : null,
+        /* @__PURE__ */ jsx("ol", { class: `${className}__list`, children: index.members.map((member) => /* @__PURE__ */ jsx("li", { class: `${className}__item`, children: /* @__PURE__ */ jsx(
+          "a",
+          {
+            class: `${className}__link`,
+            href: member.permalink,
+            "aria-current": member.slug === currentSlug ? "page" : void 0,
+            children: member.title
+          }
+        ) }, member.slug)) }),
+        /* @__PURE__ */ jsxs("div", { class: `${className}__nav`, children: [
+          previous ? /* @__PURE__ */ jsxs("a", { class: `${className}__prev`, href: previous.permalink, rel: "prev", children: [
+            "← ",
+            previous.title
+          ] }) : null,
+          next ? /* @__PURE__ */ jsxs("a", { class: `${className}__next`, href: next.permalink, rel: "next", children: [
+            next.title,
+            " →"
+          ] }) : null
+        ] })
+      ]
+    }
+  );
+});
+var series_navigation_default = SeriesNavigation;
+
 // index.ts
 function series(options = {}) {
   const models = /* @__PURE__ */ new WeakMap();
@@ -321,30 +379,11 @@ function series(options = {}) {
       version: "series-v1",
       dependencyMode: "none"
     },
-    outputDependencies: [{ type: "global" }],
+    contentOutputDependencies: [{ type: "global" }],
     options,
     validateOptions: validateSeriesOptions,
     onManifestCreated: ({ manifest, diagnostics }) => {
       diagnostics.push(...collectSeriesDiagnostics(manifest, options));
-      const view = modelFor(manifest).view;
-      const injected = /* @__PURE__ */ new Set();
-      for (const index of collectSeriesIndexes(view, options)) {
-        if (index.members.length < 2) continue;
-        for (const member of index.members) {
-          if (injected.has(member.slug)) continue;
-          const entry = view.bySlug.get(member.slug);
-          if (!entry) continue;
-          injected.add(member.slug);
-          const navigation = renderSeriesNavigation(
-            index,
-            member.slug,
-            options
-          );
-          if (!hasSlotFragment(entry.bodySlots?.["article.footer"], navigation)) {
-            appendContentBodySlot(entry, "article.footer", navigation);
-          }
-        }
-      }
     },
     pageTypes: [
       {
@@ -386,17 +425,10 @@ function series(options = {}) {
         }
       }
     ],
-    assets: [createStyleAsset("series")]
+    assets: [createStyleAsset("series", "@riebeckite/plugin-series/style.css")]
   });
 }
 var seriesPlugin = series;
-function hasSlotFragment(slot, fragment) {
-  return slot === fragment || slot?.startsWith(`${fragment}
-`) || slot?.endsWith(`
-${fragment}`) || slot?.includes(`
-${fragment}
-`) || false;
-}
 function validateSeriesOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -423,8 +455,10 @@ var DEFAULT_CLASS_NAME = resolveSeriesOptions({}).className;
 export {
   DEFAULT_CLASS_NAME,
   DEFAULT_SERIES_BASE_PATH,
+  series_navigation_default as SeriesNavigation,
   buildSeriesIndex,
   collectSeriesIndexes,
+  getSeriesNavigation,
   renderSeriesIndex,
   renderSeriesList,
   renderSeriesNavigation,

package/dist/src/series.d.ts

@@ -1,4 +1,4 @@
-import { type ContentManifest, type Diagnostic } from "@riebeckite/core";
+import { type ContentManifest, type Diagnostic, type PluginDataHelper, type PublicContentEntry, type PublicContentView } from "@riebeckite/core";
 import type { ResolvedSeriesOptions, SeriesIndex, SeriesOptions } from "./types.js";
 /** Base class applied when `options.className` is not set. */
 export declare const DEFAULT_SERIES_CLASS_NAME = "rb-series";
@@ -14,6 +14,11 @@ export declare function resolveSeriesOptions(options?: SeriesOptions): ResolvedS
 export declare function collectSeriesIndexes(manifest: ContentManifest, options?: SeriesOptions): SeriesIndex[];
 /** Returns a single series index, or `null` when no note declares `name`. */
 export declare function buildSeriesIndex(manifest: ContentManifest, name: string, options?: SeriesOptions): SeriesIndex | null;
+export declare const getSeriesNavigation: PluginDataHelper<{
+    view: PublicContentView;
+    entry: PublicContentEntry;
+    index: SeriesIndex | null;
+}, SeriesIndex | null>;
 export declare function seriesSlug(name: string): string;
 export declare function seriesLandingPath(name: string, options?: SeriesOptions): string;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-series",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -12,14 +12,21 @@
       "source": "./index.ts",
       "default": "./dist/index.js"
     },
+    "./components": {
+      "types": "./dist/components/series-navigation.d.ts",
+      "import": "./dist/components/series-navigation.js",
+      "source": "./components/series-navigation.tsx",
+      "default": "./dist/components/series-navigation.js"
+    },
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.21"
+    "hono": "^4.12.25",
+    "@riebeckite/core": "0.0.23"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.21"
+    "@riebeckite/test": "0.0.23"
   },
   "publishConfig": {
     "access": "public"