@riebeckite/plugin-garden-explorer 0.0.1

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

@@ -0,0 +1,89 @@
+# @riebeckite/plugin-garden-explorer
+
+Interactive note garden explorer: a graph, search box, tag/folder filters, and
+note details in a single page.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`gardenExplorer()` provides an interactive `GardenExplorer` component with three
+panels:
+
+- **Explorer** — search box plus tag and folder filter chips (with counts) and
+  a filtered note list
+- **Graph** — an interactive radial SVG graph of notes and internal links with
+  zoom (`+`/`−`/wheel), pan (drag), and reset
+- **Details** — the selected note's links, tags, excerpt, and related notes
+
+Selection state is mirrored to the URL query (`?note=`, `?tag=`, `?folder=`),
+so the view is shareable and the filter list adapts to the current selection.
+
+`getGardenExplorerData()` builds the note set from published entries, including
+headings, a plain-text body (truncated to 4,000 chars), tags, folders, outgoing
+links, and backlinks. Its client-side note search and radial graph layout are
+self-contained, so this plugin does not require the search plugin.
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { gardenExplorerPlugin } from "@riebeckite/plugin-garden-explorer";
+
+export default defineConfig({
+  // ...
+  plugins: [gardenExplorerPlugin()],
+});
+```
+
+`gardenExplorerPlugin()` registers the plugin in the plugin list and bundles
+`style.css` into the app stylesheet.
+
+### Render the component
+
+```tsx
+import GardenExplorer, {
+  getGardenExplorerData,
+} from "@riebeckite/plugin-garden-explorer";
+import { config } from "../config";
+import { content } from "../content";
+import { getArticleTitle } from "../lib/article-title";
+
+const manifest = await content.getManifest();
+const data = getGardenExplorerData({
+  manifest,
+  config,
+  resolveTitle: getArticleTitle,
+});
+
+// ...in your /explore route
+return <GardenExplorer data={data} />;
+```
+
+The component is client-side interactive and expects `window` to be available
+in the browser.
+
+## Data
+
+`getGardenExplorerData()` returns `GardenExplorerData`:
+
+- `notes` — published notes sorted by title, with searchable fields plus
+  `folder`, `outgoing`, and `backlinks`
+- `edges` — note-to-note graph edges between published notes
+- `tags` — tag counts, most frequent first
+- `folders` — folder counts, alphabetical; root-level notes are `"Root"`
+
+## Exports
+
+- `gardenExplorerPlugin()` — plugin factory
+- `GardenExplorer` — interactive explorer component (default export of
+  `components/garden-explorer.tsx`)
+- `getGardenExplorerData({ manifest, config, resolveTitle })` — builds the
+  explorer dataset
+- Types: `GardenExplorerData`, `GardenExplorerEdge`, `GardenExplorerFolder`,
+  `GardenExplorerNote`, `GardenExplorerTag`
+
+## See also
+
+- [Plugin guide](../../docs/plugins_en.md)
+- [`@riebeckite/plugin-local-graph`](../plugin-local-graph/README.md)

package/README_ja.md

@@ -0,0 +1,69 @@
+# @riebeckite/plugin-garden-explorer
+
+ノートの一覧、検索、タグ・フォルダーによる絞り込み、リンクグラフを一画面にまとめる探索画面です。公開済みのノートだけを対象にするため、そのまま公開サイトの `/explore` などに置けます。
+
+[English](./README.md)
+
+## 用意される画面
+
+`gardenExplorerPlugin()` は、次の三つの領域を持つ `GardenExplorer` コンポーネントとスタイルを提供します。
+
+- **一覧**: キーワード検索、タグとフォルダーのフィルター、該当ノートの一覧
+- **グラフ**: ノートと内部リンクを表示する放射状 SVG グラフ。ズーム、ドラッグ、リセットに対応
+- **詳細**: 選択したノートのリンク、タグ、抜粋、関連ノート
+
+選択状態は `?note=`、`?tag=`、`?folder=` として URL に反映されます。表示中の状態をそのまま共有できます。
+
+## 設定してページに配置する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { gardenExplorerPlugin } from "@riebeckite/plugin-garden-explorer";
+
+export default defineConfig({
+  // ...
+  plugins: [gardenExplorerPlugin()],
+});
+```
+
+ルート側では manifest から表示用データを作り、コンポーネントに渡します。
+
+```tsx
+import GardenExplorer, {
+  getGardenExplorerData,
+} from "@riebeckite/plugin-garden-explorer";
+
+const manifest = await content.getManifest();
+const data = getGardenExplorerData({
+  manifest,
+  config,
+  resolveTitle: getArticleTitle,
+});
+
+return <GardenExplorer data={data} />;
+```
+
+`GardenExplorer` はブラウザで操作するクライアントコンポーネントです。サーバーで描画するだけの場所には置かず、クライアント側で動作するルートに配置してください。
+
+## データに含まれる範囲
+
+`getGardenExplorerData()` は公開済みエントリーから、見出し、本文テキストの先頭 4,000 文字、タグ、フォルダー、送信リンク、被リンクを集めます。本文全体をクライアントへ渡さないため、検索用のデータ量を抑えられます。
+
+- `notes`: タイトル順の公開ノート。フォルダー、送信リンク、被リンクを含む
+- `edges`: 公開ノート間のグラフの辺
+- `tags`: 件数の多い順のタグ
+- `folders`: 名前順のフォルダー。ルート直下のノートは `Root`
+
+探索画面の検索はプラグイン内で完結しており、`@riebeckite/plugin-search` は不要です。
+
+## 主なエクスポート
+
+- `gardenExplorerPlugin()`: プラグインを作成する
+- `GardenExplorer`: 探索画面のコンポーネント
+- `getGardenExplorerData({ manifest, config, resolveTitle })`: 表示データを構築する
+- 型: `GardenExplorerData`、`GardenExplorerEdge`、`GardenExplorerFolder`、`GardenExplorerNote`、`GardenExplorerTag`
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)
+- [`@riebeckite/plugin-local-graph`](../local-graph/README_ja.md)

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

@@ -0,0 +1,6 @@
+import type { GardenExplorerData } from "../src/garden-explorer.js";
+type Props = {
+    data: GardenExplorerData;
+};
+export default function GardenExplorer(props: Props): import("hono/jsx/jsx-dev-runtime").JSX.Element;
+export {};