@riebeckite/plugin-excalibrain 0.0.1

package/dist/src/graph.d.ts

@@ -0,0 +1,7 @@
+import type { ExcaliBrainBuildInput, ExcaliBrainGraph } from "./types.js";
+/**
+ * Build the ExcaliBrain graph for a single note. Explicit (ontology) relations
+ * always win over inferred ones; link inference derives parents from backlinks,
+ * children from outgoing links, and left friends from mutual links.
+ */
+export declare function buildExcaliBrainGraph(input: ExcaliBrainBuildInput): ExcaliBrainGraph;

package/dist/src/init.d.ts

@@ -0,0 +1,6 @@
+import type { ExcaliBrainClientOptions } from "./types.js";
+/**
+ * Build the SVG for every client-rendered ExcaliBrain canvas. Canvases that
+ * already contain a build-time SVG (the `both` mode) are left untouched.
+ */
+export declare function initExcaliBrain(options?: ExcaliBrainClientOptions): void;

package/dist/src/layout.d.ts

@@ -0,0 +1,9 @@
+import type { ExcaliBrainGraph, ExcaliBrainLayout, ExcaliBrainOptions, ExcaliBrainRegion } from "./types.js";
+export declare const EXCALIBRAIN_REGION_ORDER: readonly ExcaliBrainRegion[];
+/**
+ * Position every node in its ExcaliBrain region. Parents sit at the top,
+ * children at the bottom, friends at the sides, previous/next at the far
+ * left/right, and siblings around the periphery. Ordering within a region is
+ * by title, so the layout is fully deterministic.
+ */
+export declare function layoutExcaliBrain(graph: ExcaliBrainGraph, options?: ExcaliBrainOptions): ExcaliBrainLayout;

package/dist/src/ontology.d.ts

@@ -0,0 +1,36 @@
+import type { ExcaliBrainOntology, ExcaliBrainNodeRole } from "./types.js";
+export type ExcaliBrainFieldRole = "parents" | "children" | "leftFriends" | "rightFriends" | "previous" | "next" | "hidden";
+/** ExcaliBrain's default ontology field names. */
+export declare const DEFAULT_ONTOLOGY: Required<ExcaliBrainOntology>;
+/** Canonical processing order; earlier roles win when a target is listed twice. */
+export declare const FIELD_ROLE_ORDER: readonly ExcaliBrainFieldRole[];
+export type ResolvedOntology = {
+    /** Normalized field name to ontology role. */
+    fieldRole: Map<string, ExcaliBrainFieldRole>;
+};
+export type DefinedRelation = {
+    role: ExcaliBrainNodeRole;
+    target: string;
+};
+/** Lowercase a field name and normalize spaces to hyphens. */
+export declare function normalizeFieldName(value: string): string;
+export declare function resolveOntology(overrides?: ExcaliBrainOntology): ResolvedOntology;
+export declare function fieldRoleOf(field: string, ontology: ResolvedOntology): ExcaliBrainFieldRole | null;
+/**
+ * Collect explicit relations from YAML frontmatter and dataview inline fields.
+ * Results follow {@link FIELD_ROLE_ORDER} so defined relations are deterministic.
+ */
+export declare function collectDefinedRelations(input: {
+    frontmatter: Record<string, unknown>;
+    markdown: string;
+    ontology: ResolvedOntology;
+}): DefinedRelation[];
+export declare function isNoteHidden(input: {
+    frontmatter: Record<string, unknown>;
+    markdown: string;
+    ontology: ResolvedOntology;
+}): boolean;
+/** 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). */
+export declare function extractInlineFields(markdown: string): Array<[string, string]>;

package/dist/src/options.d.ts

@@ -0,0 +1,20 @@
+import type { ConfigValidationIssue } from "@riebeckite/core";
+import { type ResolvedOntology } from "./ontology.js";
+import type { ExcaliBrainOptions, ExcaliBrainRenderMode } from "./types.js";
+export type ResolvedExcaliBrainOptions = {
+    render: ExcaliBrainRenderMode;
+    auto: boolean;
+    heading: boolean;
+    headingText: string;
+    className: string;
+    maxPerRegion: number;
+    infer: boolean;
+    siblings: boolean;
+    ontology: ResolvedOntology;
+    showHidden: boolean;
+    width: number;
+    height: number;
+    language: string;
+};
+export declare function resolveExcaliBrainOptions(options?: ExcaliBrainOptions): ResolvedExcaliBrainOptions;
+export declare function validateExcaliBrainOptions(options: ExcaliBrainOptions | undefined): readonly ConfigValidationIssue[];

package/dist/src/placeholder.d.ts

@@ -0,0 +1,5 @@
+export declare const EXCALIBRAIN_PLACEHOLDER_ATTRIBUTE = "data-rb-excalibrain";
+export declare function createExcaliBrainPlaceholder(): string;
+export declare function createExcaliBrainPlaceholderPattern(): RegExp;
+export declare function hasExcaliBrainPlaceholder(html: string): boolean;
+export declare function replaceExcaliBrainPlaceholders(html: string, replacement: string): string;

package/dist/src/rehype.d.ts

@@ -0,0 +1,9 @@
+import type { HastNode } from "./types.js";
+export type RehypeExcaliBrainOptions = {
+    language?: string;
+};
+/**
+ * Replace every ` ```excalibrain ` code block with a placeholder div that is
+ * resolved against the content manifest in `onManifestCreated`.
+ */
+export declare function rehypeExcaliBrain(options?: RehypeExcaliBrainOptions): (tree: HastNode) => void;

package/dist/src/render.d.ts

@@ -0,0 +1,11 @@
+import type { ExcaliBrainGraph, ExcaliBrainLayout, ExcaliBrainOptions, ExcaliBrainRenderMode } from "./types.js";
+export type ExcaliBrainSectionInput = {
+    graph: ExcaliBrainGraph;
+    layout: ExcaliBrainLayout;
+    options?: ExcaliBrainOptions;
+    render?: ExcaliBrainRenderMode;
+};
+/** Render the map as a standalone SVG string. Shared by build and client. */
+export declare function renderExcaliBrainSvg(graph: ExcaliBrainGraph, layout: ExcaliBrainLayout, options?: ExcaliBrainOptions): string;
+/** Render the `<section>` wrapper, with inline SVG and/or a client canvas. */
+export declare function renderExcaliBrainSection(input: ExcaliBrainSectionInput): string;

package/dist/src/types.d.ts

@@ -0,0 +1,123 @@
+import type { ContentManifest } from "@riebeckite/core";
+export type ExcaliBrainRenderMode = "build" | "client" | "both";
+/**
+ * ExcaliBrain relationship roles. Mirrors Zsolt Viczián's ExcaliBrain:
+ * parents, children, left/right friends, previous/next, and siblings.
+ */
+export type ExcaliBrainRole = "parent" | "child" | "leftFriend" | "rightFriend" | "previous" | "next" | "sibling";
+export type ExcaliBrainNodeRole = ExcaliBrainRole | "center";
+export type ExcaliBrainRelationType = "defined" | "inferred";
+/** Ontology field overrides. Field names are matched case-insensitively. */
+export type ExcaliBrainOntology = {
+    parents?: readonly string[];
+    children?: readonly string[];
+    leftFriends?: readonly string[];
+    rightFriends?: readonly string[];
+    previous?: readonly string[];
+    next?: readonly string[];
+    hidden?: readonly string[];
+};
+export type ExcaliBrainOptions = {
+    /** Where the map is rendered: build-time SVG, client-side, or both. */
+    render?: ExcaliBrainRenderMode;
+    /** Append the map to notes without an explicit fence. */
+    auto?: boolean;
+    /** Show the optional heading. */
+    heading?: boolean;
+    /** Heading text. */
+    headingText?: string;
+    /** Root CSS class. */
+    className?: string;
+    /** Maximum nodes rendered per region. */
+    maxPerRegion?: number;
+    /** Infer relationships from links when no explicit relation exists. */
+    infer?: boolean;
+    /** Infer siblings from the children of this note's parents. */
+    siblings?: boolean;
+    /** Ontology field overrides. */
+    ontology?: ExcaliBrainOntology;
+    /** Include notes marked hidden by the ontology. */
+    showHidden?: boolean;
+    /** SVG viewBox width. */
+    width?: number;
+    /** SVG viewBox height. */
+    height?: number;
+    /** Fence language that produces a map. */
+    language?: string;
+};
+export type ExcaliBrainNode = {
+    id: string;
+    slug: string | null;
+    title: string;
+    permalink: string | null;
+    virtual: boolean;
+    role: ExcaliBrainNodeRole;
+    relationType: ExcaliBrainRelationType;
+};
+export type ExcaliBrainLink = {
+    from: string;
+    to: string;
+    role: ExcaliBrainRole;
+    relationType: ExcaliBrainRelationType;
+};
+export type ExcaliBrainGraph = {
+    center: ExcaliBrainNode;
+    nodes: ExcaliBrainNode[];
+    links: ExcaliBrainLink[];
+};
+export type ExcaliBrainBuildInput = {
+    slug: string;
+    frontmatter: Record<string, unknown>;
+    markdown: string;
+    manifest: ContentManifest;
+    options?: ExcaliBrainOptions;
+};
+export type ExcaliBrainRegion = "parents" | "children" | "left-friends" | "right-friends" | "previous" | "next" | "siblings" | "center";
+export type ExcaliBrainPositionedNode = {
+    id: string;
+    role: ExcaliBrainNodeRole;
+    region: ExcaliBrainRegion;
+    relationType: ExcaliBrainRelationType;
+    title: string;
+    slug: string | null;
+    permalink: string | null;
+    virtual: boolean;
+    /** Top-left corner of the node box. */
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type ExcaliBrainPositionedLink = {
+    from: string;
+    to: string;
+    role: ExcaliBrainRole;
+    relationType: ExcaliBrainRelationType;
+};
+export type ExcaliBrainLayout = {
+    width: number;
+    height: number;
+    nodes: ExcaliBrainPositionedNode[];
+    links: ExcaliBrainPositionedLink[];
+};
+export type ExcaliBrainClientOptions = {
+    className?: string;
+};
+export type ElementNode = {
+    type: string;
+    tagName?: string;
+    properties?: Record<string, unknown>;
+    children?: HastNode[];
+};
+export type TextNode = {
+    type: "text";
+    value: string;
+};
+export type RawNode = {
+    type: "raw";
+    value: string;
+};
+export type HastNode = ElementNode | TextNode | RawNode | {
+    type: string;
+    [key: string]: unknown;
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@riebeckite/plugin-excalibrain",
+  "version": "0.0.1",
+  "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"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js",
+      "source": "./client.ts",
+      "default": "./dist/client.js"
+    },
+    "./style.css": "./style.css"
+  },
+  "dependencies": {
+    "@riebeckite/core": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist",
+    "style.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/excalibrain"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Relationship maps for Riebeckite notes inspired by ExcaliBrain.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "graph",
+    "obsidian"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/style.css

@@ -0,0 +1,94 @@
+.rb-excalibrain {
+  --rb-excalibrain-ink: var(--rb-color-ink, #000000);
+  --rb-excalibrain-paper: var(--rb-color-paper, #ffffff);
+  --rb-excalibrain-muted: var(--rb-color-muted, #69645c);
+  --rb-excalibrain-accent: var(--rb-color-accent, #686868);
+  --rb-excalibrain-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rb-excalibrain-ink) 18%, transparent)
+  );
+  --rb-excalibrain-surface: color-mix(
+    in srgb,
+    var(--rb-excalibrain-paper) 95%,
+    var(--rb-excalibrain-ink)
+  );
+
+  margin: 2rem 0;
+  color: var(--rb-excalibrain-ink);
+}
+
+.rb-excalibrain__heading {
+  margin: 0 0 0.5rem;
+  font-size: 1rem;
+  font-weight: 700;
+  letter-spacing: 0.02em;
+  text-transform: uppercase;
+}
+
+.rb-excalibrain__canvas {
+  overflow: auto;
+  border: 1px solid var(--rb-excalibrain-rule);
+  background: var(--rb-excalibrain-surface);
+}
+
+.rb-excalibrain__svg {
+  display: block;
+  width: 100%;
+  min-width: 32rem;
+  height: auto;
+}
+
+.rb-excalibrain__link {
+  fill: none;
+  stroke: var(--rb-excalibrain-rule);
+  stroke-width: 1.25;
+}
+
+.rb-excalibrain__link[data-relation-type="defined"] {
+  stroke: var(--rb-excalibrain-accent);
+}
+
+.rb-excalibrain__node-box {
+  fill: var(--rb-excalibrain-paper);
+  stroke: var(--rb-excalibrain-rule);
+  stroke-width: 1.25;
+}
+
+.rb-excalibrain__node[data-node-role="center"] .rb-excalibrain__node-box {
+  stroke: var(--rb-excalibrain-ink);
+  stroke-width: 2;
+}
+
+.rb-excalibrain__node[data-node-virtual="true"] .rb-excalibrain__node-box {
+  fill: none;
+  stroke-dasharray: 4 3;
+}
+
+.rb-excalibrain__node-label {
+  fill: var(--rb-excalibrain-ink);
+  font-size: 0.8125rem;
+}
+
+.rb-excalibrain__node-link {
+  text-decoration: none;
+}
+
+.rb-excalibrain__node-link:hover .rb-excalibrain__node-box,
+.rb-excalibrain__node-link:focus-visible .rb-excalibrain__node-box {
+  stroke: var(--rb-excalibrain-accent);
+  stroke-width: 2;
+}
+
+.rb-excalibrain[data-excalibrain-render="client"] .rb-excalibrain__canvas:empty::before {
+  display: block;
+  padding: 1rem;
+  content: "ExcaliBrain map is rendered in the browser.";
+  color: var(--rb-excalibrain-muted);
+  font-size: 0.8125rem;
+}
+
+html[data-theme="dark"] .rb-excalibrain,
+html.dark .rb-excalibrain {
+  --rb-excalibrain-ink: var(--rb-color-paper, #ffffff);
+  --rb-excalibrain-paper: var(--rb-color-ink, #000000);
+}