@riebeckite/plugin-excalibrain 0.0.18 → 0.0.20

package/README.md

@@ -73,9 +73,9 @@ hyphens. The default ontology is:
 
 | Role | Field names |
 | ---- | ----------- |
-| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception` |
-| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to` |
-| `leftFriends` | `friends`, `friend`, `similar`, `supports`, `alternatives`, `advantages` |
+| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception`, `source`, `parent domain` |
+| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to`, `nurtures` |
+| `leftFriends` | `friends`, `friend`, `jump`, `jumps`, `j`, `similar`, `supports`, `alternatives`, `advantages`, `pros` |
 | `rightFriends` | `opposes`, `disadvantages`, `missing`, `cons` |
 | `previous` | `previous`, `prev`, `west`, `w`, `before` |
 | `next` | `next`, `n`, `east`, `e`, `after` |
@@ -87,6 +87,9 @@ still add an existing field to another role, but earlier roles in the
 canonical order (`parents`, `children`, `leftFriends`, `rightFriends`,
 `previous`, `next`, `hidden`) win when a field is listed twice.
 
+`hidden` follows ExcaliBrain: it lists the targets to hide from this note's
+map; it never hides the note itself. `showHidden` reveals those targets.
+
 ## Inference
 
 When `infer` is enabled (the default):
@@ -101,6 +104,13 @@ setting `infer: false` disables it. Link targets are resolved against the
 content manifest; unresolved targets become virtual nodes labelled with the
 raw link text (`data-node-virtual="true"`).
 
+## Publication boundary
+
+Nodes are resolved against the content manifest. A target whose
+`publishing.routable` flag is false is dropped from the map, so notes excluded
+from publication never appear as nodes or links and their titles and permalinks
+are not leaked.
+
 ## Rendering
 
 The `render` option selects where the map is produced:
@@ -133,7 +143,7 @@ The `render` option selects where the map is produced:
 | `infer` | `boolean` | `true` | Infer relations from links |
 | `siblings` | `boolean` | `true` | Infer siblings from parents (requires `infer`) |
 | `ontology` | object | — | Ontology field names appended per role |
-| `showHidden` | `boolean` | `false` | Include notes marked hidden |
+| `showHidden` | `boolean` | `false` | Include targets named by `hidden` fields |
 | `width` | `number` | `720` | SVG viewBox width |
 | `height` | `number` | `480` | SVG viewBox height |
 | `language` | `string` | `"excalibrain"` | Fence language |
@@ -156,6 +166,15 @@ Each region is a `g.rb-excalibrain__region[data-region]`; each node is a
 wrapping an `<a href>` around its `<rect>` and `<text>`. Links are
 `path.rb-excalibrain__link[data-link-role][data-relation-type]`.
 
+## Limitations
+
+- The map is read-only. The client layer only builds the SVG; there is no drag,
+  zoom, or expand/collapse interaction.
+- `maxPerRegion` truncates each region, so a note with more relations than the
+  limit shows only the first nodes.
+- Rendering is limited to the ontology roles above; there is no per-node
+  styling or per-region configuration beyond the options listed below.
+
 ## Exports
 
 - `excaliBrain(options?)` / `excaliBrainPlugin` — plugin factory
@@ -169,5 +188,5 @@ wrapping an `<a href>` around its `<rect>` and `<text>`. Links are
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.en.md)
+- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
 

package/README_ja.md

@@ -68,9 +68,9 @@ related:: [[note-a]] and [[note-b]] are similar
 
 | ロール | フィールド名 |
 | --- | --- |
-| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception` |
-| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to` |
-| `leftFriends` | `friends`, `friend`, `similar`, `supports`, `alternatives`, `advantages` |
+| `parents` | `parent`, `parents`, `up`, `u`, `north`, `origin`, `inception`, `source`, `parent domain` |
+| `children` | `children`, `child`, `down`, `d`, `south`, `leads to`, `contributes to`, `nurtures` |
+| `leftFriends` | `friends`, `friend`, `jump`, `jumps`, `j`, `similar`, `supports`, `alternatives`, `advantages`, `pros` |
 | `rightFriends` | `opposes`, `disadvantages`, `missing`, `cons` |
 | `previous` | `previous`, `prev`, `west`, `w`, `before` |
 | `next` | `next`, `n`, `east`, `e`, `after` |
@@ -78,6 +78,8 @@ related:: [[note-a]] and [[note-b]] are similar
 
 `ontology` オプションは既定のオントロジーを拡張します。各ロールのフィールド名は、そのロールの既定値を置き換えるのではなく末尾に追加されます。既存のフィールドを別のロールに追加することもできますが、正規の順序（`parents`、`children`、`leftFriends`、`rightFriends`、`previous`、`next`、`hidden`）で先に現れるロールが優先されます。
 
+`hidden` は ExcaliBrain と同じく、このノートのマップから隠すターゲットを列挙するもので、ノート自体を隠すことはありません。`showHidden` を指定すると、これらのターゲットも表示します。
+
 ## 推論
 
 `infer` が有効な場合（既定）、次のように推論します。
@@ -88,6 +90,10 @@ related:: [[note-a]] and [[note-b]] are similar
 
 `siblings` が有効な場合（既定）、親ノートの他の子ノートを `sibling` として追加します。兄弟の推論には `infer` も必要で、`infer: false` にすると無効になります。リンク先はコンテンツマニフェストから解決し、解決できない場合は元のリンクテキストをラベルにした仮想ノード（`data-node-virtual="true"`）にします。
 
+## 公開範囲
+
+ノードはコンテンツマニフェストから解決します。`publishing.routable` が false のターゲットはマップから除外するため、公開対象外のノートがノードやリンクとして現れることはなく、タイトルやパーマリンクも漏れません。
+
 ## 描画
 
 `render` で描画する場所を選びます。
@@ -118,7 +124,7 @@ related:: [[note-a]] and [[note-b]] are similar
 | `infer` | `boolean` | `true` | リンクから関係を推論する |
 | `siblings` | `boolean` | `true` | 親から兄弟を推論する（`infer` が必要） |
 | `ontology` | object | — | ロールごとに末尾追加するオントロジーのフィールド名 |
-| `showHidden` | `boolean` | `false` | `hidden` のノートも含める |
+| `showHidden` | `boolean` | `false` | `hidden` フィールドで指定したターゲットも含める |
 | `width` | `number` | `720` | SVG viewBox の幅 |
 | `height` | `number` | `480` | SVG viewBox の高さ |
 | `language` | `string` | `"excalibrain"` | 対象にするフェンス言語 |
@@ -138,6 +144,12 @@ related:: [[note-a]] and [[note-b]] are similar
 
 領域は `g.rb-excalibrain__region[data-region]`、ノードは `g.rb-excalibrain__node[data-node-role][data-node-slug][data-relation-type]` で、`<a href>` が `<rect>` と `<text>` を包みます。リンクは `path.rb-excalibrain__link[data-link-role][data-relation-type]` です。
 
+## 制約
+
+- マップは閲覧専用です。クライアント側の処理は SVG を生成するだけで、ドラッグ、ズーム、展開・折りたたみの操作はありません。
+- `maxPerRegion` は領域ごとのノード数を打ち切るため、関係が多いノートでは先頭のノードだけを表示します。
+- 描画できるのは上記のオントロジーのロールだけで、ノード単位のスタイルや領域単位の設定は下記のオプション以外にありません。
+
 ## 主なエクスポート
 
 - `excaliBrain(options?)` / `excaliBrainPlugin`: プラグインを作成する
@@ -149,5 +161,5 @@ related:: [[note-a]] and [[note-b]] are similar
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/docs/reference/plugin-api.md)
+- [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)
 

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import type { ExcaliBrainOptions } from "./src/types.js";
 export { buildExcaliBrainGraph } from "./src/graph.js";
 export { layoutExcaliBrain } from "./src/layout.js";
 export type { DefinedRelation, ResolvedOntology, } from "./src/ontology.js";
-export { collectDefinedRelations, DEFAULT_ONTOLOGY, isNoteHidden, normalizeFieldName, resolveOntology, } from "./src/ontology.js";
+export { collectDefinedRelations, collectHiddenTargets, DEFAULT_ONTOLOGY, normalizeFieldName, resolveOntology, } from "./src/ontology.js";
 export type { ResolvedExcaliBrainOptions } from "./src/options.js";
 export { resolveExcaliBrainOptions, validateExcaliBrainOptions, } from "./src/options.js";
 export { renderExcaliBrainSection, renderExcaliBrainSvg, } from "./src/render.js";

package/dist/index.js

@@ -7,7 +7,17 @@ import {
 
 // src/ontology.ts
 var DEFAULT_ONTOLOGY = {
-  parents: ["parent", "parents", "up", "u", "north", "origin", "inception"],
+  parents: [
+    "parent",
+    "parents",
+    "up",
+    "u",
+    "north",
+    "origin",
+    "inception",
+    "source",
+    "parent domain"
+  ],
   children: [
     "children",
     "child",
@@ -15,15 +25,20 @@ var DEFAULT_ONTOLOGY = {
     "d",
     "south",
     "leads to",
-    "contributes to"
+    "contributes to",
+    "nurtures"
   ],
   leftFriends: [
     "friends",
     "friend",
+    "jump",
+    "jumps",
+    "j",
     "similar",
     "supports",
     "alternatives",
-    "advantages"
+    "advantages",
+    "pros"
   ],
   rightFriends: ["opposes", "disadvantages", "missing", "cons"],
   previous: ["previous", "prev", "west", "w", "before"],
@@ -95,14 +110,18 @@ function collectDefinedRelations(input) {
   }
   return relations;
 }
-function isNoteHidden(input) {
-  for (const field of Object.keys(input.frontmatter)) {
-    if (fieldRoleOf(field, input.ontology) === "hidden") return true;
+function collectHiddenTargets(input) {
+  const targets = [];
+  const inlineFields = extractInlineFields(input.markdown);
+  for (const [field, value] of Object.entries(input.frontmatter)) {
+    if (fieldRoleOf(field, input.ontology) !== "hidden") continue;
+    targets.push(...extractTargets(value));
   }
-  for (const [field] of extractInlineFields(input.markdown)) {
-    if (fieldRoleOf(field, input.ontology) === "hidden") return true;
+  for (const [field, value] of inlineFields) {
+    if (fieldRoleOf(field, input.ontology) !== "hidden") continue;
+    targets.push(...extractTargets(value));
   }
-  return false;
+  return targets;
 }
 var WIKILINK_PATTERN = /\[\[([^\]|#^]+)(?:[#^][^\]|]+)?(?:\|[^\]]+)?\]\]/g;
 function extractWikilinkTargets(value) {
@@ -236,16 +255,19 @@ function buildExcaliBrainGraph(input) {
     role: "center",
     relationType: "defined"
   };
-  if (!options.showHidden && isNoteHidden({
-    frontmatter: input.frontmatter,
-    markdown: input.markdown,
-    ontology: options.ontology
-  })) {
-    return { center, nodes: [], links: [] };
-  }
+  const hiddenTargets = new Set(
+    collectHiddenTargets({
+      frontmatter: input.frontmatter,
+      markdown: input.markdown,
+      ontology: options.ontology
+    }).map((target) => target.trim().toLowerCase())
+  );
   const relations = /* @__PURE__ */ new Map();
   const add = (target, role, relationType) => {
     if (role === "center") return;
+    if (!options.showHidden && hiddenTargets.has(target.trim().toLowerCase())) {
+      return;
+    }
     const node = resolveNode(target, slug, manifest, input.isRoutable);
     if (!node) return;
     const existing = relations.get(node.id);
@@ -774,9 +796,9 @@ export {
   DEFAULT_ONTOLOGY,
   buildExcaliBrainGraph,
   collectDefinedRelations,
+  collectHiddenTargets,
   excaliBrain,
   excaliBrainPlugin,
-  isNoteHidden,
   layoutExcaliBrain,
   normalizeFieldName,
   renderExcaliBrainSection,

package/dist/src/ontology.d.ts

@@ -25,11 +25,16 @@ export declare function collectDefinedRelations(input: {
     markdown: string;
     ontology: ResolvedOntology;
 }): DefinedRelation[];
-export declare function isNoteHidden(input: {
+/**
+ * Collect the targets this note hides with its `hidden` fields. ExcaliBrain's
+ * `hidden` field lists the targets to hide from the note's map; it never
+ * hides the note itself.
+ */
+export declare function collectHiddenTargets(input: {
     frontmatter: Record<string, unknown>;
     markdown: string;
     ontology: ResolvedOntology;
-}): boolean;
+}): string[];
 /** Extract `[[target]]` link targets from a raw value. */
 export declare function extractWikilinkTargets(value: string): string[];
 /** Extract `Field:: value` pairs from the note body (frontmatter excluded). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-excalibrain",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,11 +21,11 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.18"
+    "@riebeckite/core": "0.0.20"
   },
   "devDependencies": {
     "tsx": "^4.22.4",
-    "@riebeckite/test": "0.0.18"
+    "@riebeckite/test": "0.0.20"
   },
   "publishConfig": {
     "access": "public"

package/style.css

@@ -88,8 +88,14 @@
   font-size: 0.8125rem;
 }
 
-html[data-theme="dark"] .rb-excalibrain,
-html.dark .rb-excalibrain {
+:is(:root, .rb-theme-root)[data-theme="dark"] .rb-excalibrain {
   --rb-excalibrain-ink: var(--rb-color-paper, #ffffff);
   --rb-excalibrain-paper: var(--rb-color-ink, #000000);
 }
+
+@media (prefers-color-scheme: dark) {
+  :is(:root, .rb-theme-root):not([data-theme]) .rb-excalibrain {
+    --rb-excalibrain-ink: var(--rb-color-paper, #ffffff);
+    --rb-excalibrain-paper: var(--rb-color-ink, #000000);
+  }
+}