@riebeckite/plugin-navigation 0.0.0-stage → 0.0.17

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,127 @@
-# Temporary Holding Version
+# @riebeckite/plugin-navigation
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Site navigation as a Riebeckite plugin. `navigation()` derives the primary
+navigation from the notes already in the vault, so an existing Obsidian vault
+becomes navigable with no Riebeckite-specific file and no required frontmatter.
+The plugin owns the navigation *model*; the Site shell owns rendering and
+placement.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`navigation()` reads the manifest's discoverable entries — the notes that are
+published and routable — and groups them by their slug hierarchy:
+
+- a folder becomes a section;
+- an `index` or `README` note links its folder, and the folder's first-level
+  note becomes its child;
+- every other note becomes a link;
+- titles come from the note's own `title`, falling back to the slug segment.
+
+A folder with no index note still renders as a label grouped around its
+children. Drafts, scheduled and otherwise non-discoverable notes never appear,
+because the model is built from `manifest.discoverableEntries`.
+
+Nothing in the vault has to change: no `navigation.md`, no navigation
+frontmatter, no re-declaring what the folder structure already says.
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { navigation } from "@riebeckite/plugin-navigation";
+
+export default defineConfig({
+  // ...
+  plugins: [navigation()],
+});
+```
+
+The Site shell renders the model. In a HonoX site:
+
+```tsx
+import { content } from "../content";
+import { resolveSiteNavigation } from "@riebeckite/plugin-navigation";
+
+const model = resolveSiteNavigation(config, await content.getManifest());
+const primary = model?.primary ?? [];
+const secondary = model?.secondary ?? [];
+```
+
+`resolveSiteNavigation` returns `null` when the plugin is not registered, so a
+site without navigation keeps working.
+
+## Authored navigation
+
+Automated derivation cannot express everything, and some sites curate their
+links deliberately. Pass `items` to replace derivation with authored links:
+
+```ts
+navigation({
+  items: [
+    { label: "Docs", href: "/docs/" },
+    { label: "Reference", href: "/docs/reference/" },
+    {
+      label: "Themes",
+      href: "/docs/themes/",
+      children: [
+        { label: "Default", href: "/docs/themes/default" },
+        { label: "Writing a theme", href: "/docs/themes/writing-a-theme" },
+      ],
+    },
+  ],
+});
+```
+
+`secondary` holds supplementary links a Site may render less prominently:
+
+```ts
+navigation({
+  secondary: [
+    { label: "Docs", href: "/docs/" },
+    { label: "GitHub", href: "https://github.com/Rerurate514/riebeckite", external: true },
+  ],
+});
+```
+
+`primary` and `secondary` describe prominence, not placement. Where each list
+is rendered — a header, a footer, a sidebar — is the Site's decision.
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `items` | `NavigationItem[]` | derived | Authored primary navigation |
+| `secondary` | `NavigationItem[]` | `[]` | Supplementary links |
+
+`NavigationItem` is `{ label, href?, children?, external? }`. `href` is optional
+on the type because a derived folder group may not have an index note; authored
+items require a non-empty `href`, and `external` marks links that open in a new
+tab.
+
+## Exports
+
+- `navigation(options?)` — plugin factory
+- `navigationPlugin` — alias of `navigation`
+- `NAVIGATION_PLUGIN_NAME` — the plugin name, `"navigation"`
+- `buildNavigation(entries, options?)` — build a model from manifest entries
+- `resolveSiteNavigation(config, manifest)` — find the enabled plugin and build
+  the model, or `null`
+- `validateNavigationOptions(options)` — option validation
+- Types: `NavigationItem`, `NavigationOptions`, `NavigationSource`,
+  `SiteNavigation`
+
+## Limitations
+
+- Derivation follows the rendered language when the `l10n` plugin writes
+  language metadata, so a localized vault's navigation never mixes languages.
+  In a vault without localization metadata, every discoverable entry is used.
+- Ordering is alphabetical by title. Frontmatter ordering is not read.
+- There is no `exclude`/`include`/`order` option yet; add one only when a real
+  site needs it.
+
+## See also
+
+- [Configuration reference](../../../docs/en/docs/reference/configuration.md)
+- [Plugin guide](../../../docs/en/docs/reference/plugin-api.md)

package/README_ja.md

@@ -0,0 +1,127 @@
+# @riebeckite/plugin-navigation
+
+サイトナビゲーションを提供する Riebeckite プラグインです。`navigation()` は
+Vault にすでにあるノートから主要ナビゲーションを導出します。Riebeckite 専用の
+ファイルも必須 frontmatter も不要なので、既存の Obsidian Vault をそのまま
+公開できます。ナビゲーションの「モデル」はプラグインが持ち、描画と配置は
+Site シェルが担当します。
+
+[English](./README.md)
+
+## 仕組み
+
+`navigation()` はマニフェストの discoverable エントリ（公開され、ルーティング
+可能なノート）を読み、スラッグ階層でまとめます。
+
+- フォルダはセクションになる
+- `index` / `README` ノートはそのフォルダへのリンクになり、同じフォルダの
+  直下のノートは子になる
+- それ以外のノートはリンクになる
+- タイトルはノート自身の `title` を使い、なければスラッグのセグメントから作る
+
+index ノートを持たないフォルダは、子をまとめたラベルとして表示されます。
+モデルは `manifest.discoverableEntries` から作るため、下書き・予約公開・
+その他の非表示ノートは決して現れません。
+
+Vault 側の変更は不要です。`navigation.md` もナビゲーション用 frontmatter も
+要らず、フォルダ構造がすでに表していることを再入力する必要もありません。
+
+## 使い方
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { navigation } from "@riebeckite/plugin-navigation";
+
+export default defineConfig({
+  // ...
+  plugins: [navigation()],
+});
+```
+
+Site シェルがモデルを描画します。HonoX サイトでは次のように使います。
+
+```tsx
+import { content } from "../content";
+import { resolveSiteNavigation } from "@riebeckite/plugin-navigation";
+
+const model = resolveSiteNavigation(config, await content.getManifest());
+const primary = model?.primary ?? [];
+const secondary = model?.secondary ?? [];
+```
+
+プラグインが登録されていない場合、`resolveSiteNavigation` は `null` を返すため、
+ナビゲーションのないサイトもそのまま動作します。
+
+## 手書きナビゲーション
+
+自動導出ですべてを表現できるわけではなく、リンクを意図的に整えたいサイトも
+あります。`items` を渡すと導出の代わりに手書きリンクを使います。
+
+```ts
+navigation({
+  items: [
+    { label: "Docs", href: "/docs/" },
+    { label: "Reference", href: "/docs/reference/" },
+    {
+      label: "Themes",
+      href: "/docs/themes/",
+      children: [
+        { label: "Default", href: "/docs/themes/default" },
+        { label: "Writing a theme", href: "/docs/themes/writing-a-theme" },
+      ],
+    },
+  ],
+});
+```
+
+`secondary` は Site が控えめに描画してよい補助リンクを保持します。
+
+```ts
+navigation({
+  secondary: [
+    { label: "Docs", href: "/docs/" },
+    { label: "GitHub", href: "https://github.com/Rerurate514/riebeckite", external: true },
+  ],
+});
+```
+
+`primary` と `secondary` は配置ではなく目立ちやすさを表します。それぞれを
+ヘッダー・フッター・サイドバーのどこに描画するかは Site が決めます。
+
+## オプション
+
+| オプション | 型 | 既定値 | 説明 |
+| ---------- | -- | ------ | ---- |
+| `items` | `NavigationItem[]` | 導出値 | 手書きの主要ナビゲーション |
+| `secondary` | `NavigationItem[]` | `[]` | 補助リンク |
+
+`NavigationItem` は `{ label, href?, children?, external? }` です。導出された
+フォルダグループは index ノートを持たないことがあるため `href` は型上省略
+可能ですが、手書きアイテムには空でない `href` が必要です。`external` は別タブで
+開くリンクを表します。
+
+## エクスポート
+
+- `navigation(options?)` — プラグインファクトリ
+- `navigationPlugin` — `navigation` のエイリアス
+- `NAVIGATION_PLUGIN_NAME` — プラグイン名 `"navigation"`
+- `buildNavigation(entries, options?)` — マニフェストエントリからモデルを構築する
+- `resolveSiteNavigation(config, manifest)` — 有効なプラグインを見つけてモデルを
+  構築する。なければ `null`
+- `validateNavigationOptions(options)` — オプションの検証
+- 型: `NavigationItem`, `NavigationOptions`, `NavigationSource`,
+  `SiteNavigation`
+
+## 制約
+
+- `l10n` Plugin が言語 metadata を付与している場合、導出は表示中の言語に追従し、
+  多言語 Vault の Navigation が言語を混在させることはありません。localization
+  metadata のない Vault では、discoverable な全 entry を使います。
+- 並び順はタイトルのアルファベット順です。frontmatter の順序は読みません。
+- `exclude` / `include` / `order` はまだありません。実際のサイトが必要とした
+  ときにだけ追加します。
+
+## 関連リンク
+
+- [設定リファレンス](../../../docs/ja/docs/reference/configuration.md)
+- [プラグイン API](../../../docs/ja/docs/reference/plugin-api.md)

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import type { NavigationOptions } from "./src/types.js";
+export { buildNavigation, NAVIGATION_PLUGIN_NAME, resolveSiteNavigation, } from "./src/navigation.js";
+export type { NavigationItem, NavigationOptions, NavigationSource, SiteNavigation, } from "./src/types.js";
+export declare function navigation(options?: NavigationOptions): import("@riebeckite/core").RiebeckitePlugin<NavigationOptions>;
+export declare const navigationPlugin: typeof navigation;

package/dist/index.js

@@ -0,0 +1,177 @@
+// index.ts
+import { definePlugin } from "@riebeckite/core";
+
+// src/navigation.ts
+import {
+  selectEntriesByLanguage
+} from "@riebeckite/core";
+var ROOT_SEGMENT = "";
+var LOCALIZATION_TRANSLATION_KEY = "l10n.translationId";
+var NAVIGATION_PLUGIN_NAME = "navigation";
+function buildNavigation(entries, options = {}) {
+  return {
+    primary: options.items ?? deriveNavigation(entries),
+    secondary: options.secondary ?? []
+  };
+}
+function resolveSiteNavigation(source, manifest, language) {
+  const plugin = source.plugins?.find(
+    (candidate) => candidate.name === NAVIGATION_PLUGIN_NAME && candidate.enabled !== false
+  );
+  if (!plugin) return null;
+  return buildNavigation(
+    selectEntriesByLanguage(manifest.discoverableEntries, language),
+    plugin.options ?? {}
+  );
+}
+function validateNavigationOptions(options) {
+  if (!options || typeof options !== "object") return [];
+  const issues = [];
+  validateItems(options.items, "items", issues, /* @__PURE__ */ new Set());
+  validateItems(options.secondary, "secondary", issues, /* @__PURE__ */ new Set());
+  return issues;
+}
+function deriveNavigation(entries) {
+  const nodes = entries.map(toNavigationEntry).filter((entry) => Boolean(entry));
+  const root = createTreeNode(ROOT_SEGMENT);
+  for (const node of nodes) addEntry(root, node);
+  return buildItems(root);
+}
+function toNavigationEntry(entry) {
+  const path = entry.publicLocation.metadata?.[LOCALIZATION_TRANSLATION_KEY] ?? entry.slug;
+  const segments = path.split("/").filter(Boolean);
+  if (segments.length === 0) return null;
+  const isIndex = ["index", "README"].includes(segments.at(-1) ?? "");
+  return {
+    entry,
+    segments,
+    isIndex,
+    title: resolveTitle(entry, segments)
+  };
+}
+function resolveTitle(entry, segments) {
+  if (entry.title.trim()) return entry.title.trim();
+  return titleFromSegment(segments.at(-1) ?? entry.slug);
+}
+function addEntry(root, entry) {
+  const path = entry.isIndex ? entry.segments.slice(0, -1) : entry.segments;
+  let node = root;
+  for (const segment of path) {
+    const child = node.children.get(segment) ?? createTreeNode(segment);
+    node.children.set(segment, child);
+    node = child;
+  }
+  if (entry.isIndex) node.indexes.push(entry);
+  else node.page = entry;
+}
+function buildItems(node) {
+  return [...node.children.values()].toSorted(compareNodes).map(nodeToItem);
+}
+function nodeToItem(node) {
+  const singleIndex = node.indexes.length === 1 ? node.indexes[0] : void 0;
+  const primary = singleIndex ?? (node.indexes.length === 0 ? node.page : void 0);
+  const extra = node.indexes.length <= 1 ? singleIndex && node.page ? [node.page] : [] : [...node.indexes, ...node.page ? [node.page] : []];
+  const children = [
+    ...extra.map((entry) => toItem(entry)),
+    ...buildItems(node)
+  ];
+  if (primary) return toItem(primary, children);
+  return {
+    label: titleFromSegment(node.segment),
+    children
+  };
+}
+function toItem(entry, children = []) {
+  return {
+    label: entry.title,
+    href: entry.entry.permalink,
+    ...children.length === 0 ? {} : { children }
+  };
+}
+function compareNodes(a, b) {
+  const left = a.indexes[0] ?? a.page;
+  const right = b.indexes[0] ?? b.page;
+  const leftTitle = left?.title ?? titleFromSegment(a.segment);
+  const rightTitle = right?.title ?? titleFromSegment(b.segment);
+  const title = leftTitle.localeCompare(rightTitle, "en", {
+    sensitivity: "base"
+  });
+  if (title !== 0) return title;
+  return a.segment.localeCompare(b.segment, "en", { sensitivity: "base" });
+}
+function createTreeNode(segment) {
+  return { segment, indexes: [], children: /* @__PURE__ */ new Map() };
+}
+function titleFromSegment(segment) {
+  return segment.replace(/[-_]+/g, " ").replace(/\b\p{L}/gu, (letter) => letter.toLocaleUpperCase("en"));
+}
+function validateItems(value, path, issues, ancestors) {
+  if (value === void 0) return;
+  if (!Array.isArray(value)) {
+    issues.push({ path, message: "Expected an array." });
+    return;
+  }
+  for (const [index, item] of value.entries()) {
+    const itemPath = `${path}[${index}]`;
+    if (!isRecord(item)) {
+      issues.push({ path: itemPath, message: "Expected an object." });
+      continue;
+    }
+    if (ancestors.has(item)) {
+      issues.push({
+        path: itemPath,
+        message: "Navigation children must not be recursive."
+      });
+      continue;
+    }
+    if (typeof item.label !== "string" || item.label.trim() === "") {
+      issues.push({
+        path: `${itemPath}.label`,
+        message: "Expected a non-empty string."
+      });
+    }
+    if (typeof item.href !== "string" || item.href.trim() === "") {
+      issues.push({
+        path: `${itemPath}.href`,
+        message: "Expected a non-empty string."
+      });
+    }
+    if (item.external !== void 0 && typeof item.external !== "boolean") {
+      issues.push({
+        path: `${itemPath}.external`,
+        message: "Expected a boolean."
+      });
+    }
+    if (item.children !== void 0) {
+      const nextAncestors = new Set(ancestors);
+      nextAncestors.add(item);
+      validateItems(
+        item.children,
+        `${itemPath}.children`,
+        issues,
+        nextAncestors
+      );
+    }
+  }
+}
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+// index.ts
+function navigation(options = {}) {
+  return definePlugin({
+    name: NAVIGATION_PLUGIN_NAME,
+    options,
+    validateOptions: validateNavigationOptions,
+    outputDependencies: [{ type: "global" }]
+  });
+}
+var navigationPlugin = navigation;
+export {
+  NAVIGATION_PLUGIN_NAME,
+  buildNavigation,
+  navigation,
+  navigationPlugin,
+  resolveSiteNavigation
+};

package/dist/src/navigation.d.ts

@@ -0,0 +1,6 @@
+import { type ConfigValidationIssue, type ContentManifest, type ContentManifestEntry } from "@riebeckite/core";
+import type { NavigationOptions, NavigationSource, SiteNavigation } from "./types.js";
+export declare const NAVIGATION_PLUGIN_NAME = "navigation";
+export declare function buildNavigation(entries: readonly ContentManifestEntry[], options?: NavigationOptions): SiteNavigation;
+export declare function resolveSiteNavigation(source: NavigationSource, manifest: ContentManifest, language?: string): SiteNavigation | null;
+export declare function validateNavigationOptions(options: NavigationOptions | undefined): readonly ConfigValidationIssue[];

package/dist/src/types.d.ts

@@ -0,0 +1,28 @@
+import type { ContentManifestEntry } from "@riebeckite/core";
+export type NavigationItem = {
+    readonly label: string;
+    readonly href?: string;
+    readonly children?: readonly NavigationItem[];
+    readonly external?: boolean;
+};
+export type NavigationOptions = {
+    readonly items?: readonly NavigationItem[];
+    readonly secondary?: readonly NavigationItem[];
+};
+export type SiteNavigation = {
+    readonly primary: readonly NavigationItem[];
+    readonly secondary: readonly NavigationItem[];
+};
+export type NavigationEntry = {
+    readonly entry: ContentManifestEntry;
+    readonly segments: readonly string[];
+    readonly isIndex: boolean;
+    readonly title: string;
+};
+export type NavigationSource = {
+    readonly plugins?: readonly {
+        readonly name: string;
+        readonly options?: unknown;
+        readonly enabled?: boolean;
+    }[];
+};

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@riebeckite/plugin-navigation",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.17",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@riebeckite/core": "0.0.17"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4",
+    "@riebeckite/test": "0.0.17"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/navigation"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Site navigation model for Riebeckite, derived from the vault or authored in config.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "navigation"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
+  }
 }