@riebeckite/plugin-bases 0.0.1

package/dist/src/evaluate.d.ts

@@ -0,0 +1,6 @@
+import type { ContentManifestEntry } from "@riebeckite/core";
+import type { BasesCondition, BasesValueRef } from "./types.js";
+/** Evaluates a compiled condition against one manifest entry. */
+export declare function matchesCondition(condition: BasesCondition, entry: ContentManifestEntry): boolean;
+/** Reads the entry value a filter reference points at. */
+export declare function resolveValueRef(reference: BasesValueRef, entry: ContentManifestEntry): unknown;

package/dist/src/parse.d.ts

@@ -0,0 +1,19 @@
+import type { BasesSpec, BasesValueRef } from "./types.js";
+/** Columns used when neither the Base nor the view configures any. */
+export declare const DEFAULT_COLUMNS: readonly ["file.name", "file.tags"];
+type Result<T> = {
+    readonly ok: true;
+    readonly value: T;
+} | {
+    readonly ok: false;
+    readonly message: string;
+};
+/**
+ * Compiles a parsed YAML Base document into the serializable spec the renderer
+ * consumes. Returns a diagnostic message when the document uses a shape the
+ * MVP cannot understand; the caller keeps the original code block in that case.
+ */
+export declare function parseBases(document: unknown): Result<BasesSpec>;
+/** Maps a property id (e.g. `file.name`, `note.status`, `draft`) to its ref. */
+export declare function parseValueRef(raw: string): BasesValueRef;
+export {};

package/dist/src/placeholder.d.ts

@@ -0,0 +1,21 @@
+import type { BasesSpec } from "./types.js";
+/**
+ * Build-time placeholder that stands in for a `base` code block until the
+ * content manifest (and therefore every entry's frontmatter, tags, links, and
+ * permalink) is available.
+ *
+ * The compiled spec and the raw block source are URI-encoded so they survive an
+ * HTML attribute round-trip through `rehype-raw` without quoting hazards. The
+ * attribute is removed when the runtime replaces the placeholder with rendered
+ * HTML, so it never reaches the published page.
+ */
+export declare const BASES_ATTRIBUTE = "data-rr-bases";
+export type BasesPlaceholderPayload = {
+    readonly spec: BasesSpec;
+    readonly source: string;
+};
+export declare function encodeBasesPayload(payload: BasesPlaceholderPayload): string;
+export declare function decodeBasesPayload(encoded: string): BasesPlaceholderPayload | null;
+export declare function createBasesPlaceholder(payload: BasesPlaceholderPayload): string;
+/** A fresh global pattern is returned per call to avoid shared `lastIndex`. */
+export declare function createBasesPlaceholderPattern(): RegExp;

package/dist/src/remark.d.ts

@@ -0,0 +1,14 @@
+import type { Root } from "mdast";
+export type RemarkBasesOptions = {
+    /** Fenced code block language treated as a Base. Defaults to `base`. */
+    language?: string;
+};
+/**
+ * Replaces fenced `base` code blocks with a build-time placeholder.
+ *
+ * The YAML body is parsed immediately so that invalid or unsupported
+ * definitions can be reported and left untouched (the code block survives);
+ * the compiled spec is carried inside the placeholder and rendered later, once
+ * the content manifest exists.
+ */
+export declare function remarkBases(options?: RemarkBasesOptions): (tree: Root, file: unknown) => void;

package/dist/src/render.d.ts

@@ -0,0 +1,6 @@
+import { type ContentManifestEntry } from "@riebeckite/core";
+import type { BasesOptions, BasesSpec } from "./types.js";
+/** Renders a compiled Base definition to HTML. */
+export declare function renderBases(spec: BasesSpec, options: BasesOptions, entries: readonly ContentManifestEntry[], source: string): string;
+/** Renders an inline error when a placeholder cannot be resolved. */
+export declare function renderBasesError(message: string, options: BasesOptions): string;

package/dist/src/runtime.d.ts

@@ -0,0 +1,13 @@
+import type { ContentManifest, Diagnostic, PostContent, ResolvedRiebeckiteConfig } from "@riebeckite/core";
+import type { BasesOptions } from "./types.js";
+export type BasesRuntime = {
+    /**
+     * Remembers the processed content object for a slug. `ContentManager` caches
+     * and reuses this exact object, so replacing its `html` here is what makes the
+     * rewrite visible to consumers that render `getProcessedContent()`.
+     */
+    track(slug: string, content: PostContent): void;
+    /** Replaces every Base placeholder in the manifest with rendered output. */
+    resolve(manifest: ContentManifest, diagnostics: Diagnostic[], config?: ResolvedRiebeckiteConfig): void;
+};
+export declare function createBasesRuntime(options: BasesOptions): BasesRuntime;

package/dist/src/types.d.ts

@@ -0,0 +1,82 @@
+import type { ContentQuerySort } from "@riebeckite/core";
+/** View kinds supported by the MVP renderer. */
+export type BasesViewType = "table" | "cards";
+/** Scalar literal that can appear on the right-hand side of a comparison. */
+export type BasesLiteral = string | number | boolean | null;
+/** Comparison operators supported in filter expressions. */
+export type BasesOperator = "==" | "!=" | ">" | "<" | ">=" | "<=" | "contains";
+/** Built-in `file.*` values exposed to filter expressions. */
+export type BasesBuiltinValue = "file.name" | "file.path" | "file.slug" | "file.folder" | "file.title" | "file.link" | "file.permalink" | "file.tags";
+/** A value read either from a built-in or from frontmatter. */
+export type BasesValueRef = {
+    readonly source: "builtin";
+    readonly name: BasesBuiltinValue;
+} | {
+    readonly source: "frontmatter";
+    readonly key: string;
+};
+/**
+ * A compiled Base filter condition. The tree mirrors the `and` / `or` / `not`
+ * shape of an Obsidian Base and is evaluated against manifest entries.
+ */
+export type BasesCondition = {
+    readonly kind: "and";
+    readonly conditions: readonly BasesCondition[];
+} | {
+    readonly kind: "or";
+    readonly conditions: readonly BasesCondition[];
+} | {
+    readonly kind: "not";
+    readonly condition: BasesCondition;
+} | {
+    readonly kind: "hasTag";
+    readonly tag: string;
+} | {
+    readonly kind: "inFolder";
+    readonly folder: string;
+} | {
+    readonly kind: "hasLink";
+    readonly link: string;
+} | {
+    readonly kind: "compare";
+    readonly left: BasesValueRef;
+    readonly operator: BasesOperator;
+    readonly right: BasesLiteral;
+};
+/** A compiled Base view. */
+export type BasesView = {
+    readonly type: BasesViewType;
+    /** Optional human-readable label; rendered above the view output. */
+    readonly name?: string;
+    /** Property ids used as table columns (or card fields). */
+    readonly columns: readonly string[];
+    /** View-local filter, combined with the top-level filter using AND. */
+    readonly filter?: BasesCondition;
+    /** Sort keys, mapped onto the Core content query sort shape. */
+    readonly sort?: readonly ContentQuerySort[];
+    /** View-local row cap. Still bounded by {@link BasesOptions.limit}. */
+    readonly limit?: number;
+};
+/** A compiled Base definition. */
+export type BasesSpec = {
+    /** Top-level filter applied to every view. */
+    readonly filter?: BasesCondition;
+    /** Property id -> display label. */
+    readonly properties: Readonly<Record<string, string>>;
+    readonly views: readonly BasesView[];
+};
+export type BasesOptions = {
+    /** Root CSS class. Defaults to `rb-bases`. */
+    className?: string;
+    /** Fenced code block language. Defaults to `base`. */
+    language?: string;
+    /** Global row cap applied to every view. Defaults to `100`. */
+    limit?: number;
+    /** Render the raw Base definition in a `<details>` fallback. Defaults to `true`. */
+    showFallback?: boolean;
+    /**
+     * Name of the single view to render when a Base defines several. When unset,
+     * every view is rendered as a labelled section.
+     */
+    view?: string;
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@riebeckite/plugin-bases",
+  "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"
+    },
+    "./style.css": "./style.css"
+  },
+  "dependencies": {
+    "@types/mdast": "^4.0.4",
+    "unist-util-visit": "^5.1.0",
+    "vfile-matter": "^5.0.1",
+    "@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/bases"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Build-time rendering for Obsidian Bases definitions.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "obsidian",
+    "bases"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/style.css

@@ -0,0 +1,145 @@
+.rb-bases {
+  --rb-bases-ink: var(--rb-color-ink, #000000);
+  --rb-bases-paper: var(--rb-color-paper, #ffffff);
+  --rb-bases-muted: var(--rb-color-muted, #69645c);
+  --rb-bases-accent: var(--rb-color-accent, #686868);
+  --rb-bases-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rb-bases-ink) 18%, transparent)
+  );
+  --rb-bases-surface: color-mix(
+    in srgb,
+    var(--rb-bases-paper) 94%,
+    var(--rb-bases-ink)
+  );
+
+  margin: 1.5rem 0;
+  color: var(--rb-bases-ink);
+}
+
+.rb-bases__view + .rb-bases__view {
+  margin-top: 1.5rem;
+}
+
+.rb-bases__view-name {
+  margin: 0 0 0.5rem;
+  font-size: 0.9375rem;
+  font-weight: 700;
+  letter-spacing: 0.01em;
+}
+
+.rb-bases__table {
+  width: 100%;
+  border-collapse: collapse;
+  font-size: 0.9375rem;
+}
+
+.rb-bases__heading {
+  padding: 0.5rem 0.75rem;
+  border-bottom: 1px solid var(--rb-bases-ink);
+  text-align: left;
+  font-weight: 700;
+}
+
+.rb-bases__cell {
+  padding: 0.5rem 0.75rem;
+  vertical-align: top;
+}
+
+.rb-bases__row:not(:last-child) .rb-bases__cell {
+  border-bottom: 1px solid var(--rb-bases-rule);
+}
+
+.rb-bases__link {
+  color: inherit;
+  text-decoration: underline;
+  text-decoration-color: var(--rb-bases-rule);
+  text-underline-offset: 0.2em;
+}
+
+.rb-bases__link:hover,
+.rb-bases__link:focus-visible {
+  text-decoration-color: var(--rb-bases-accent);
+}
+
+.rb-bases__tag {
+  margin-right: 0.35rem;
+  color: var(--rb-bases-muted);
+  font-size: 0.8125em;
+  white-space: nowrap;
+}
+
+.rb-bases__cards {
+  display: grid;
+  grid-template-columns: repeat(auto-fill, minmax(15rem, 1fr));
+  gap: 0.75rem;
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+.rb-bases__card {
+  padding: 0.75rem 1rem;
+  border: 1px solid var(--rb-bases-rule);
+  background: var(--rb-bases-surface);
+}
+
+.rb-bases__card-title {
+  font-weight: 700;
+}
+
+.rb-bases__fields {
+  display: grid;
+  grid-template-columns: auto 1fr;
+  gap: 0.15rem 0.75rem;
+  margin: 0.5rem 0 0;
+  font-size: 0.875rem;
+}
+
+.rb-bases__field {
+  display: contents;
+}
+
+.rb-bases__field-label {
+  color: var(--rb-bases-muted);
+  font-weight: 400;
+}
+
+.rb-bases__field-value {
+  margin: 0;
+}
+
+.rb-bases__empty {
+  margin: 0;
+  color: var(--rb-bases-muted);
+  font-style: italic;
+}
+
+.rb-bases__fallback {
+  margin-top: 1rem;
+  color: var(--rb-bases-muted);
+  font-size: 0.8125rem;
+}
+
+.rb-bases__fallback pre {
+  overflow-x: auto;
+  margin: 0.5rem 0 0;
+  padding: 0.75rem;
+  border: 1px solid var(--rb-bases-rule);
+  background: var(--rb-bases-surface);
+  font-size: 0.8125rem;
+}
+
+.rb-bases--error {
+  margin: 1.5rem 0;
+  padding: 0.75rem 1rem;
+  border: 1px solid var(--rb-bases-ink);
+  background: var(--rb-bases-surface);
+  font-size: 0.875rem;
+}
+
+html[data-theme="dark"] .rb-bases,
+html.dark .rb-bases {
+  --rb-bases-ink: var(--rb-color-paper, #ffffff);
+  --rb-bases-paper: var(--rb-color-ink, #000000);
+}