@riebeckite/plugin-garden-explorer 0.0.31 → 0.0.33

package/README.md

@@ -9,7 +9,7 @@ tag/folder filters, and note details in a single page.
 
 ## Overview
 
-`gardenExplorerPlugin()` provides an interactive `GardenExplorer` component with
+`gardenExplorer()` provides an interactive `GardenExplorer` component with
 three panels:
 
 - **Explorer** — search box plus optional tag and folder filter chips (with
@@ -61,11 +61,11 @@ of rescanning the vault in the browser.
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { gardenExplorerPlugin } from "@riebeckite/plugin-garden-explorer";
+import { gardenExplorer } from "@riebeckite/plugin-garden-explorer";
 
 export default defineConfig({
   // ...
-  plugins: [gardenExplorerPlugin()],
+  plugins: [gardenExplorer()],
 });
 ```
 
@@ -73,7 +73,7 @@ With configuration:
 
 ```ts
 plugins: [
-  gardenExplorerPlugin({
+  gardenExplorer({
     layout: "force",
     depth: 1,
     showTags: true,
@@ -86,7 +86,7 @@ plugins: [
 ];
 ```
 
-`gardenExplorerPlugin()` registers the `/explore` page type and bundles
+`gardenExplorer()` registers the `/explore` page type and bundles
 `style.css` and its client hydrator into the app. A catch-all route using
 `resolveRiebeckiteRoute()` and `pluginPageSsgParams()` renders and emits it;
 no plugin-specific application route is needed. The page is server-rendered
@@ -132,7 +132,7 @@ explorer/detail structure and links in semantic lists.
 
 ## Exports
 
-- `gardenExplorerPlugin(options?)` — plugin factory
+- `gardenExplorer(options?)` — plugin factory
 - `GardenExplorer` — interactive explorer component (default export of
   `components/garden-explorer.tsx`)
 - `getGardenExplorerData({ manifest, config, resolveTitle, options? })` — builds

package/README_ja.md

@@ -8,39 +8,39 @@
 
 ## 用意される画面
 
-`gardenExplorerPlugin()` は、次の三つの領域を持つ `GardenExplorer` コンポーネントとスタイルを提供します。
+`gardenExplorer()` は、次の三つの領域を持つ `GardenExplorer` コンポーネントとスタイルを提供します。
 
 - **一覧**: キーワード検索、任意表示のタグ・フォルダーフィルター、該当ノートの一覧
-- **グラフ**: 公開ノートと内部リンクを表示する SVG グラフ。Local / Global の切り替え、force / radial layout、hover 時の隣接ノート強調、ノード drag、wheel / button zoom に対応します。canvas pan、reset、クリックで記事へ移動にも対応します
+- **グラフ**: 公開ノートと内部リンクを表示する SVG グラフ。Local / Global の切り替え、Force / Radial レイアウト、ホバー時の隣接ノート強調、ノードのドラッグ、ホイール / ボタンによるズームに対応します。キャンバスのパン、リセット、クリックでの記事移動にも対応します
 - **詳細**: 選択したノートのリンク、タグ、抜粋、関連ノート
 
 選択状態は `?note=`、`?tag=`、`?folder=` として URL に反映されます。表示中の状態をそのまま共有できます。
 
-`getGardenExplorerData()` は `manifest.discoverableEntries` と `manifest.graph` から表示データを作ります。見出し、本文テキストの先頭 4,000 文字、タグ、フォルダー、送信リンク、被リンクを含みます。Graph のノードは公開・発見可能なページと解決済み note link だけなので、未公開・除外・存在しないページは表示されません。
+`getGardenExplorerData()` は `manifest.discoverableEntries` と `manifest.graph` から表示データを作ります。見出し、本文テキストの先頭 4,000 文字、タグ、フォルダー、外向きリンク、被リンクを含みます。グラフのノードは公開・発見可能なページと解決済みのノートリンクだけなので、未公開・除外・存在しないページは表示されません。
 
-Explorer パネルのノート一覧は、UI 性能のため先頭 80 件に制限して表示します。Global Graph は絞り込み後の全ノートを使用します。URL で選択されたノートが先頭 80 件の外にある場合、Global Graph で保持されます。
+一覧パネルに表示するノートは、UI 性能のため先頭 80 件に制限します。Global Graph は絞り込み後の全ノートを使用します。URL で選択されたノートが先頭 80 件の外にある場合、Global Graph で保持されます。
 
 ## Local Graph と Global Graph
 
-- **Local Graph** は選択中のノートを起点に、`depth` で指定した hop 数までの隣接ノートを表示します。既定値は `depth: 1` で、Obsidian / Quartz と同じく直接の outgoing link と backlink を見る用途に合わせています。`depth: 0` では選択中のノートだけを表示します。
+- **Local Graph** は選択中のノートを起点に、`depth` で指定したホップ数までの隣接ノートを表示します。既定値は `depth: 1` で、Obsidian / Quartz と同じく直接の外向きリンクと被リンクを見る用途に合わせています。`depth: 0` では選択中のノートだけを表示します。
 - **Global Graph** は現在の検索・タグ・フォルダー条件で絞り込まれた公開ノート全体と、その公開内部リンクを表示します。
 
-操作感は Obsidian の Graph View に寄せています。ただし、Vault をブラウザ側で再探索しません。代わりに、Riebeckite の Page System、public manifest、permalink、Content Graph をそのまま使います。
+操作感は Obsidian の Graph View に寄せています。ただし、ブラウザで Vault を走査し直すことはありません。代わりに、Riebeckite の Page System、公開マニフェスト、パーマリンク、Content Graph をそのまま使います。
 
-## Layout
+## レイアウト
 
-- **Force layout**（`layout: "force"`、既定）: 小さな組み込み実装です。repulsion、link distance、centering、damping、安定化を行います。重い依存は追加していません。大きなグラフ（300 ノード以上）では force layout の計算時間が目立つようになり、ツールバーに警告が表示されます。大きな Global Graph には radial layout の使用を推奨します。500 ノード以上では、ユーザーの明示的な承認なしに force layout は実行されません。
-- **Radial layout**（`layout: "radial"`）: 既存の Riebeckite の放射状 layout を使います。コンパクトで決定的な見た目にしたい場合に使えます。近似線形時間で動作し、数千ノードでも瞬時に描画できます。
+- **Force レイアウト**（`layout: "force"`、既定）: 小さな組み込み実装です。反発力、リンク距離、中心化、減衰、安定化を計算します。重い依存は追加していません。大きなグラフ（300 ノード以上）では Force レイアウトの計算時間が目立つようになり、ツールバーに警告が表示されます。大きな Global Graph には Radial レイアウトの使用を推奨します。500 ノード以上では、ユーザーの明示的な承認なしに Force レイアウトは実行されません。
+- **Radial レイアウト**（`layout: "radial"`）: 既存の Riebeckite の放射状レイアウトを使います。コンパクトで決定的な見た目にしたい場合に使えます。近似線形時間で動作し、数千ノードでも瞬時に描画できます。
 
-## 設定してページに配置する
+## 設定とページへの配置
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
-import { gardenExplorerPlugin } from "@riebeckite/plugin-garden-explorer";
+import { gardenExplorer } from "@riebeckite/plugin-garden-explorer";
 
 export default defineConfig({
   // ...
-  plugins: [gardenExplorerPlugin()],
+  plugins: [gardenExplorer()],
 });
 ```
 
@@ -48,7 +48,7 @@ export default defineConfig({
 
 ```ts
 plugins: [
-  gardenExplorerPlugin({
+  gardenExplorer({
     layout: "force",
     depth: 1,
     showTags: true,
@@ -61,9 +61,9 @@ plugins: [
 ];
 ```
 
-`gardenExplorerPlugin()` は `/explore` の Page Type、スタイル、クライアント側の hydrator を登録します。`resolveRiebeckiteRoute()` と `pluginPageSsgParams()` を使う共通 catch-all route が表示と SSG を担当します。そのため、Plugin 固有の route は不要です。ページはまずサーバーで描画し、読み込み後に登録済みの client entry がグラフ、フィルター、URL 状態を hydration します。
+`gardenExplorer()` は `/explore` の Page Type、スタイル、クライアント側のハイドレーターを登録します。`resolveRiebeckiteRoute()` と `pluginPageSsgParams()` を使う共通 catch-all ルートが表示と SSG を担当します。そのため、プラグイン固有のルートは不要です。ページはまずサーバーで描画し、読み込み後に登録済みのクライアントエントリがグラフ、フィルター、URL 状態をハイドレーションします。
 
-コンポーネントを別の site-owned component に埋め込む場合だけ、manifest から表示用データを作って渡します。
+コンポーネントを別のサイトが用意するコンポーネントに埋め込む場合だけ、マニフェストから表示用データを作って渡します。
 
 ```tsx
 import GardenExplorer, {
@@ -81,23 +81,23 @@ const data = getGardenExplorerData({
 return <GardenExplorer data={data} />;
 ```
 
-`GardenExplorer` はブラウザで操作するクライアントコンポーネントです。サーバー描画時にも周辺の一覧・詳細パネルは semantic なリンク一覧として読める構造を残します。
+`GardenExplorer` はブラウザで操作するクライアントコンポーネントです。サーバー描画時にも、周辺の一覧・詳細パネルはセマンティックなリンク一覧として読み取れる構造を残します。
 
 ## データに含まれる範囲
 
-`getGardenExplorerData()` は公開済みエントリーから、見出し、本文テキストの先頭 4,000 文字、タグ、フォルダー、送信リンク、被リンクを集めます。本文全体をクライアントへ渡さないため、検索用のデータ量を抑えられます。
+`getGardenExplorerData()` は公開済みエントリーから、見出し、本文テキストの先頭 4,000 文字、タグ、フォルダー、外向きリンク、被リンクを集めます。本文全体をクライアントへ渡さないため、検索用のデータ量を抑えられます。
 
-- `notes`: タイトル順の公開ノート。フォルダー、送信リンク、被リンクを含む
+- `notes`: タイトル順の公開ノート。フォルダー、外向きリンク、被リンクを含む
 - `edges`: 公開ノート間のグラフの辺
 - `tags`: 件数の多い順のタグ
 - `folders`: 名前順のフォルダー。ルート直下のノートは `Root`
-- `options`: hydration 後の component が使う解決済み graph 設定
+- `options`: ハイドレーション後のコンポーネントが使う解決済みグラフ設定
 
 探索画面の検索はプラグイン内で完結しており、`@riebeckite/plugin-search` は不要です。
 
 ## 主なエクスポート
 
-- `gardenExplorerPlugin(options?)`: プラグインを作成する
+- `gardenExplorer(options?)`: プラグインを作成する
 - `GardenExplorer`: 探索画面のコンポーネント
 - `getGardenExplorerData({ manifest, config, resolveTitle, options? })`: 表示データを構築する
 - 型: `GardenExplorerData`、`GardenExplorerEdge`、`GardenExplorerFolder`、`GardenExplorerGraphLayout`、`GardenExplorerGraphMode`、`GardenExplorerNote`、`GardenExplorerOptions`、`GardenExplorerPluginOptions`、`GardenExplorerTag`

package/dist/index.d.ts

@@ -2,4 +2,4 @@ import type { GardenExplorerPluginOptions } from "./src/garden-explorer.js";
 export { default as GardenExplorer } from "./components/garden-explorer.js";
 export type { GardenExplorerData, GardenExplorerEdge, GardenExplorerFolder, GardenExplorerNote, GardenExplorerOptions, GardenExplorerPluginOptions, GardenExplorerTag, } from "./src/garden-explorer.js";
 export { getGardenExplorerData } from "./src/garden-explorer.server.js";
-export declare function gardenExplorerPlugin(options?: GardenExplorerPluginOptions): import("@riebeckite/core").RiebeckitePlugin<unknown>;
+export declare function gardenExplorer(options?: GardenExplorerPluginOptions): import("@riebeckite/core").RiebeckitePlugin<unknown>;

package/dist/index.js

@@ -2,9 +2,7 @@
 import { createClientEntry, definePlugin } from "@riebeckite/core";
 
 // src/garden-explorer.server.ts
-import {
-  buildGraphEdges
-} from "@riebeckite/core";
+import { buildGraphEdges } from "@riebeckite/core/client";
 var MAX_BODY_LENGTH = 4e3;
 function getGardenExplorerData(args) {
   const graph = args.manifest.graph;
@@ -874,7 +872,7 @@ function renderGardenExplorerPage(data, siteTitle) {
 }
 
 // index.ts
-function gardenExplorerPlugin(options = {}) {
+function gardenExplorer(options = {}) {
   return definePlugin({
     name: "garden-explorer",
     assets: [
@@ -920,6 +918,6 @@ function gardenExplorerPlugin(options = {}) {
 }
 export {
   GardenExplorer,
-  gardenExplorerPlugin,
+  gardenExplorer,
   getGardenExplorerData
 };

package/dist/src/garden-explorer.d.ts

@@ -1,4 +1,4 @@
-import type { GraphEdge } from "@riebeckite/core";
+import type { GraphEdge } from "@riebeckite/core/client";
 type GardenExplorerSearchFields = {
     slug: string;
     permalink: string;
@@ -15,7 +15,7 @@ export type GardenExplorerNote = GardenExplorerSearchFields & {
     backlinks: string[];
 };
 export type GardenExplorerEdge = GraphEdge;
-export type GardenExplorerGraphLayout = "force" | "radial";
+type GardenExplorerGraphLayout = "force" | "radial";
 export type GardenExplorerGraphMode = "local" | "global";
 export type GardenExplorerOptions = {
     layout: GardenExplorerGraphLayout;

package/dist/src/garden-explorer.server.d.ts

@@ -1,4 +1,4 @@
-import { type ContentManifest, type ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { ContentManifest, ResolvedRiebeckiteConfig } from "@riebeckite/core";
 import type { GardenExplorerData, GardenExplorerOptions, GardenExplorerPluginOptions } from "./garden-explorer.js";
 type TitleResolver = (slug: string, title: unknown) => string;
 export declare function getGardenExplorerData(args: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-garden-explorer",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -27,8 +27,8 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "hono": "^4.12.25",
-    "@riebeckite/core": "0.0.31"
+    "@riebeckite/core": "0.0.33",
+    "hono": "^4.12.25"
   },
   "publishConfig": {
     "access": "public"