@riebeckite/graph 0.0.0-stage → 0.0.36

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,174 @@
-# Temporary Holding Version
+# @riebeckite/graph
 
-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.
+Shared graph engine for Riebeckite's Local Graph and Garden Explorer.
+
+[日本語](./README_ja.md)
+
+## What it provides
+
+`@riebeckite/graph` turns the public content manifest into a graph document and
+renders it with a Canvas 2D force simulation and Obsidian-style controls. The
+same engine powers both the article Local Graph and the Global Graph, so
+physics, camera, filters, groups, persistence, and lifecycle behavior are not
+duplicated between plugins.
+
+- Server-safe data building from public entries, unresolved links, public
+  attachments, and tags
+- Obsidian-compatible subset of graph search: `file:`, `path:`, `tag:`, quoted
+  phrases, and `-` negation
+- Filters for tags, attachments, unresolved files, and orphans
+- Ordered color groups with first-match priority
+- Continuous center, repel, link, and link-distance forces with deterministic
+  initial placement and automatic settling
+- Canvas renderer with wheel/pinch zoom at the pointer, background pan, node
+  drag, hover emphasis, labels that fade by zoom, arrows, groups, animation, and
+  pointer/keyboard/context-menu interaction
+- Settings persistence through `localStorage`
+- Pause when off-screen or when the document is hidden, plus cleanup for SPA
+  page transitions
+
+## Usage
+
+```ts
+import {
+  buildGraphDocument,
+  buildVisibleGraph,
+  DEFAULT_GRAPH_SETTINGS,
+} from "@riebeckite/graph";
+import { createGraphRenderer } from "@riebeckite/graph/client";
+```
+
+Build a document from public entries:
+
+```ts
+const document = buildGraphDocument(
+  entries.map((entry) => ({
+    slug: entry.slug,
+    title: entry.title,
+    permalink: entry.permalink,
+    tags: entry.tags,
+    links: entry.links,
+    assets: entry.assets,
+    date: entry.date ?? null,
+  })),
+  { centerSlug: entry.slug },
+);
+```
+
+Mount the renderer in a browser-only effect:
+
+```ts
+const renderer = createGraphRenderer({
+  canvas,
+  reducedMotion: window.matchMedia("(prefers-reduced-motion: reduce)").matches,
+});
+
+renderer.update({
+  document,
+  settings: DEFAULT_GRAPH_SETTINGS,
+  mode: "global",
+});
+
+return () => renderer.destroy();
+```
+
+For a ready-made UI, use the shared component:
+
+```tsx
+import GraphView from "@riebeckite/graph/ui";
+import "@riebeckite/graph/style.css";
+
+<GraphView
+  document={document}
+  mode="local"
+  centerId={entry.slug}
+  initialSettings={{ depth: 1 }}
+  maxDepth={3}
+  expandable
+  storageKey="example-graph-settings"
+/>;
+```
+
+`GraphView` is safe to server-render. It creates the renderer and reads
+`localStorage` only in effects, so it can be hydrated by the client lifecycle
+used by Riebeckite plugins.
+
+## Settings
+
+Defaults follow Obsidian's graph view where the public data model allows it:
+
+| Setting | Default | Range |
+| --- | --- | --- |
+| Depth | 2 | 0–5 |
+| Tags | on | — |
+| Attachments | on | — |
+| Existing files only | off | — |
+| Orphans | on | — |
+| Arrows | off | — |
+| Text fade threshold | 0.35 | 0–1 |
+| Node size | 1 | 0.5–2.5 |
+| Link thickness | 1 | 0.25–3 |
+| Center force | 0.35 | 0–1 |
+| Repel force | 600 | 0–2000 |
+| Link force | 0.7 | 0–1 |
+| Link distance | 100 | 30–500 |
+
+`normalizeGraphSettings()` clamps stored values and rejects malformed groups.
+`restore defaults` on the settings panel returns to these values while keeping
+the mode-specific depth cap.
+
+## Public boundary
+
+Build graph input from `manifest.discoverableEntries` or
+`PublicContentView.discoverableEntries`. Never pass private, draft, scheduled,
+or unlisted entries to the browser. Resolved links to non-public notes are
+removed by `PublicContentView`; unresolved links preserve only the text that is
+already in the public note. `buildGraphDocument` also drops note links whose
+target is not present in the supplied entries.
+
+## Performance
+
+The simulation uses exact pair repulsion for small graphs and a Barnes-Hut-style
+quadtree above 250 nodes. The renderer draws with Canvas 2D, uses a device-pixel
+ratio cap of 2, skips off-screen edges and nodes, limits labels on dense graphs,
+and stops requesting animation frames once the simulation settles.
+
+`pnpm --filter @riebeckite/graph benchmark` runs synthetic 100 / 675 / 1,000 /
+3,000 node graphs with low and high edge density. On the development machine,
+settling 3,000 nodes with about 3,600 links takes roughly 1.15 seconds of
+simulation work and about 3.8 ms per tick. In the browser, average frame time
+stays within a 60 Hz frame at that size, though dense 3,000-node graphs with
+about 11,900 links exceed it on some frames (about 12.4 ms average and 24 ms at
+the 95th percentile). These numbers are machine dependent.
+
+`d3-force` was evaluated as the default engine. The custom simulation was kept
+because it gives deterministic initial placement, explicit pin/release and
+reheat control for dragging, and a small dependency-free surface that is shared
+by both plugins. Its Barnes-Hut-style quadtree provides the same asymptotic
+repulsion behavior without adding a runtime dependency. It is not a drop-in
+replacement for every `d3-force` behavior.
+
+## Exports
+
+- `buildGraphDocument(entries, options)`
+- `sliceGraphDocument(document, centerId, depth, maxNodes)`
+- `buildVisibleGraph({ document, settings, mode, centerId })`
+- `collectLocalNodeIds(adjacency, centerId, depth)`
+- `parseGraphQuery`, `matchesGraphQuery`, `normalizeGraphText`
+- `createGraphSimulation`, `buildRevealSchedule`, `hasDatedNodes`
+- `DEFAULT_GRAPH_SETTINGS`, `GRAPH_SETTINGS_RANGES`, `mergeGraphSettings`,
+  `normalizeGraphSettings`, `readStoredGraphSettings`,
+  `writeStoredGraphSettings`
+- `@riebeckite/graph/client`: `createGraphRenderer`
+- `@riebeckite/graph/ui`: default `GraphView`
+- Types: `GraphDocument`, `GraphNode`, `GraphLink`, `GraphSettings`,
+  `GraphGroup`, `GraphMode`, `VisibleGraph`, `VisibleGraphNode`,
+  `GraphRenderer`, `GraphViewProps`
+
+## Development
+
+```sh
+pnpm --filter @riebeckite/graph test
+pnpm --filter @riebeckite/graph benchmark
+pnpm --filter @riebeckite/graph build
+```

package/README_ja.md

@@ -0,0 +1,141 @@
+# @riebeckite/graph
+
+Riebeckite の Local Graph と Garden Explorer が共有するグラフエンジンです。
+
+[English](./README.md)
+
+## 提供する機能
+
+`@riebeckite/graph` は公開コンテンツのマニフェストからグラフドキュメントを構築し、Canvas 2D の強制シミュレーションと Obsidian 風の操作 UI で描画します。記事内の Local Graph と Global Graph が同じエンジンを使うため、物理演算、カメラ、フィルター、グループ、設定の保存、ライフサイクル管理をプラグインごとに複製していません。
+
+- 公開エントリ、未解決リンク、公開添付ファイル、タグからサーバー側でデータを構築
+- Obsidian 互換の検索サブセット: `file:`、`path:`、`tag:`、引用符、`-` 否定
+- タグ、添付ファイル、未解決ファイル、孤立ノートのフィルター
+- 順序付きの色分けグループ（最初に一致したものが優先）
+- Center / Repel / Link / Link distance の継続的な力。初期配置は再現性があり、安定後は自動停止
+- ポインター中心のホイール／ピンチズーム、背景パン、ノードドラッグ、ホバー強調、ズームに応じたラベルのフェード、矢印、グループ、アニメーション、ポインター／キーボード／右クリック操作を備えた Canvas レンダラー
+- `localStorage` による設定の保存と復元
+- 画面外・非表示時の一時停止と、SPA ページ遷移時の確実な解放
+
+## 使い方
+
+```ts
+import {
+  buildGraphDocument,
+  buildVisibleGraph,
+  DEFAULT_GRAPH_SETTINGS,
+} from "@riebeckite/graph";
+import { createGraphRenderer } from "@riebeckite/graph/client";
+```
+
+公開エントリからドキュメントを構築します。
+
+```ts
+const document = buildGraphDocument(
+  entries.map((entry) => ({
+    slug: entry.slug,
+    title: entry.title,
+    permalink: entry.permalink,
+    tags: entry.tags,
+    links: entry.links,
+    assets: entry.assets,
+    date: entry.date ?? null,
+  })),
+  { centerSlug: entry.slug },
+);
+```
+
+ブラウザ専用の effect でレンダラーをマウントします。
+
+```ts
+const renderer = createGraphRenderer({
+  canvas,
+  reducedMotion: window.matchMedia("(prefers-reduced-motion: reduce)").matches,
+});
+
+renderer.update({
+  document,
+  settings: DEFAULT_GRAPH_SETTINGS,
+  mode: "global",
+});
+
+return () => renderer.destroy();
+```
+
+UI をそのまま使う場合:
+
+```tsx
+import GraphView from "@riebeckite/graph/ui";
+import "@riebeckite/graph/style.css";
+
+<GraphView
+  document={document}
+  mode="local"
+  centerId={entry.slug}
+  initialSettings={{ depth: 1 }}
+  maxDepth={3}
+  expandable
+  storageKey="example-graph-settings"
+/>;
+```
+
+`GraphView` はサーバー描画に対応します。レンダラーの生成と `localStorage` の読み書きは effect 内だけで行うため、Riebeckite のプラグインが使うクライアントライフサイクルでハイドレートできます。
+
+## 設定
+
+公開データモデルで表現できる範囲は Obsidian の Graph View に合わせています。
+
+| 設定 | 初期値 | 範囲 |
+| --- | --- | --- |
+| Depth | 2 | 0–5 |
+| Tags | オン | — |
+| Attachments | オン | — |
+| Existing files only | オフ | — |
+| Orphans | オン | — |
+| Arrows | オフ | — |
+| Text fade threshold | 0.35 | 0–1 |
+| Node size | 1 | 0.5–2.5 |
+| Link thickness | 1 | 0.25–3 |
+| Center force | 0.35 | 0–1 |
+| Repel force | 600 | 0–2000 |
+| Link force | 0.7 | 0–1 |
+| Link distance | 100 | 30–500 |
+
+`normalizeGraphSettings()` は保存値をクランプし、不正なグループを除外します。設定パネルの Restore defaults は、モードごとの Depth 上限を保ったまま初期値へ戻します。
+
+## 公開境界
+
+グラフの入力は `manifest.discoverableEntries` または `PublicContentView.discoverableEntries` から構築してください。非公開、下書き、予約公開、unlisted のエントリをブラウザへ渡してはいけません。非公開ノートへの解決済みリンクは `PublicContentView` が除去し、未解決リンクは公開ノートにすでに書かれているテキストだけを保持します。`buildGraphDocument` も、渡されたエントリに存在しないノートへのリンクを破棄します。
+
+## 性能
+
+シミュレーションは小規模グラフでは全ペアの反発力、250ノード超では Barnes-Hut 方式の四分木を使います。レンダラーは Canvas 2D、デバイスピクセル比の上限2、画面外の辺・ノードのスキップ、高密度時のラベル数制限を行い、シミュレーションが安定すると `requestAnimationFrame` の要求を止めます。
+
+`pnpm --filter @riebeckite/graph benchmark` は 100 / 675 / 1,000 / 3,000 ノードを低密度・高密度の辺で計測します。開発機では約3,600リンクの3,000ノードが約1.15秒（1ティック約3.8ms）で安定します。ブラウザではこの規模でも平均フレーム時間は60Hzの1フレーム以内ですが、約11,900リンクの高密度3,000ノードでは一部のフレームで超えます（平均約12.4ms、95パーセンタイル約24ms）。数値は実行環境に依存します。
+
+`d3-force` も既定エンジンの候補として評価しました。独自シミュレーションを採用した理由は、決定的な初期配置、ドラッグ時の固定・解放と再加熱の明示的な制御、両プラグインで共有できる依存なしの小さな実装面です。Barnes-Hut 方式の四分木により、実行時依存を増やさずに同等のオーダーの反発計算を行います。`d3-force` のすべての挙動を置き換えるものではありません。
+
+## 公開 API
+
+- `buildGraphDocument(entries, options)`
+- `sliceGraphDocument(document, centerId, depth, maxNodes)`
+- `buildVisibleGraph({ document, settings, mode, centerId })`
+- `collectLocalNodeIds(adjacency, centerId, depth)`
+- `parseGraphQuery`、`matchesGraphQuery`、`normalizeGraphText`
+- `createGraphSimulation`、`buildRevealSchedule`、`hasDatedNodes`
+- `DEFAULT_GRAPH_SETTINGS`、`GRAPH_SETTINGS_RANGES`、`mergeGraphSettings`、
+  `normalizeGraphSettings`、`readStoredGraphSettings`、
+  `writeStoredGraphSettings`
+- `@riebeckite/graph/client`: `createGraphRenderer`
+- `@riebeckite/graph/ui`: デフォルトの `GraphView`
+- 型: `GraphDocument`、`GraphNode`、`GraphLink`、`GraphSettings`、
+  `GraphGroup`、`GraphMode`、`VisibleGraph`、`VisibleGraphNode`、
+  `GraphRenderer`、`GraphViewProps`
+
+## 開発
+
+```sh
+pnpm --filter @riebeckite/graph test
+pnpm --filter @riebeckite/graph benchmark
+pnpm --filter @riebeckite/graph build
+```

package/dist/benchmark/run.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/client.d.ts

@@ -0,0 +1,34 @@
+import type { GraphDocument, GraphMode, GraphNode, GraphSettings } from "./index.js";
+export type GraphRendererCallbacks = {
+    onSelect?: (node: GraphNode | null) => void;
+    onOpen?: (node: GraphNode) => void;
+    onHover?: (node: GraphNode | null) => void;
+    onContextMenu?: (node: GraphNode, x: number, y: number) => void;
+    onAnimationChange?: (animating: boolean) => void;
+};
+export type GraphRendererInput = {
+    document: GraphDocument;
+    settings: GraphSettings;
+    mode: GraphMode;
+    centerId?: string | null;
+    selectedId?: string | null;
+};
+export type GraphRendererOptions = GraphRendererCallbacks & {
+    canvas: HTMLCanvasElement;
+    reducedMotion?: boolean;
+};
+export type GraphRenderer = {
+    update(input: GraphRendererInput): void;
+    setSelected(id: string | null): void;
+    zoomBy(factor: number, origin?: {
+        x: number;
+        y: number;
+    }): void;
+    resetView(): void;
+    focusNode(id: string): void;
+    playAnimation(): void;
+    stopAnimation(): void;
+    isAnimating(): boolean;
+    destroy(): void;
+};
+export declare function createGraphRenderer(options: GraphRendererOptions): GraphRenderer;