@riebeckite/plugin-dataview 0.0.1

package/dist/src/evaluate.d.ts

@@ -0,0 +1,28 @@
+import type { ContentManifest, ContentManifestEntry } from "@riebeckite/core";
+import type { DataviewExpression, DataviewFrom, DataviewSpec } from "./types.js";
+export type DataviewScope = {
+    entry: ContentManifestEntry;
+    manifest: ContentManifest;
+};
+export type DataviewGroup = {
+    key: string;
+    entries: ContentManifestEntry[];
+};
+export type DataviewSelection = {
+    entries: ContentManifestEntry[];
+    groups: DataviewGroup[];
+    grouped: boolean;
+};
+export declare class DataviewEvaluationError extends Error {
+}
+/**
+ * Select the manifest entries a spec matches, applying `FROM`, `WHERE`, `SORT`,
+ * `LIMIT`, and `GROUP BY` in that order.
+ */
+export declare function selectDataviewEntries(spec: DataviewSpec, manifest: ContentManifest, defaultLimit: number | null): DataviewSelection;
+export declare function matchesDataviewFrom(from: DataviewFrom | null, entry: ContentManifestEntry, manifest: ContentManifest): boolean;
+export declare function evaluateDataviewExpression(expression: DataviewExpression, scope: DataviewScope): unknown;
+export declare function readDataviewField(entry: ContentManifestEntry, path: readonly string[], _manifest?: ContentManifest): unknown;
+export declare function isTruthy(value: unknown): boolean;
+/** Parse a value into a millisecond timestamp, or `null` when impossible. */
+export declare function toDataviewTime(value: unknown): number | null;

package/dist/src/parse.d.ts

@@ -0,0 +1,11 @@
+import type { DataviewParseResult } from "./types.js";
+declare class DataviewParseError extends Error {
+}
+/**
+ * Parse a declarative `dataview` block body into a {@link DataviewSpec}.
+ *
+ * The parser never throws: unsupported or malformed input is reported as a
+ * failed {@link DataviewParseResult} so callers can render a fallback.
+ */
+export declare function parseDataview(source: string): DataviewParseResult;
+export { DataviewParseError };

package/dist/src/placeholder.d.ts

@@ -0,0 +1,5 @@
+export declare const DATAVIEW_ATTRIBUTE = "data-rr-dataview";
+export declare function encodeDataviewSource(source: string): string;
+export declare function decodeDataviewSource(encoded: string): string;
+export declare function createDataviewPlaceholder(source: string): string;
+export declare function createDataviewPlaceholderPattern(): RegExp;

package/dist/src/remark.d.ts

@@ -0,0 +1,5 @@
+import type { Root } from "mdast";
+export type RemarkDataviewOptions = {
+    language?: string;
+};
+export declare function remarkDataview(options?: RemarkDataviewOptions): (tree: Root, file: unknown) => void;

package/dist/src/render.d.ts

@@ -0,0 +1,4 @@
+import { type DataviewSelection } from "./evaluate.js";
+import type { DataviewSpec, ResolvedDataviewOptions } from "./types.js";
+export declare function renderDataview(selection: DataviewSelection, spec: DataviewSpec, options: ResolvedDataviewOptions, source: string): string;
+export declare function renderDataviewError(message: string, source: string, options: ResolvedDataviewOptions): string;

package/dist/src/runtime.d.ts

@@ -0,0 +1,7 @@
+import type { ContentManifest, Diagnostic, PostContent } from "@riebeckite/core";
+import { type DataviewOptions } from "./types.js";
+export type DataviewRuntime = {
+    track(slug: string, content: PostContent): void;
+    resolve(manifest: ContentManifest, diagnostics: Diagnostic[]): void;
+};
+export declare function createDataviewRuntime(options?: DataviewOptions): DataviewRuntime;

package/dist/src/types.d.ts

@@ -0,0 +1,95 @@
+export type DataviewQueryType = "list" | "table" | "task" | "calendar";
+export type DataviewSortOrder = "asc" | "desc";
+export type DataviewSort = {
+    field: string;
+    order: DataviewSortOrder;
+};
+export type DataviewColumn = {
+    field: string;
+    label?: string;
+};
+export type DataviewComparisonOperator = "=" | "!=" | ">" | "<" | ">=" | "<=";
+export type DataviewSource = {
+    kind: "tag";
+    value: string;
+} | {
+    kind: "folder";
+    value: string;
+} | {
+    kind: "link";
+    value: string;
+};
+export type DataviewFrom = {
+    kind: "source";
+    source: DataviewSource;
+} | {
+    kind: "not";
+    child: DataviewFrom;
+} | {
+    kind: "and";
+    left: DataviewFrom;
+    right: DataviewFrom;
+} | {
+    kind: "or";
+    left: DataviewFrom;
+    right: DataviewFrom;
+};
+export type DataviewExpression = {
+    kind: "literal";
+    value: string | number | boolean | null;
+} | {
+    kind: "field";
+    path: readonly string[];
+} | {
+    kind: "not";
+    operand: DataviewExpression;
+} | {
+    kind: "and";
+    left: DataviewExpression;
+    right: DataviewExpression;
+} | {
+    kind: "or";
+    left: DataviewExpression;
+    right: DataviewExpression;
+} | {
+    kind: "compare";
+    operator: DataviewComparisonOperator;
+    left: DataviewExpression;
+    right: DataviewExpression;
+} | {
+    kind: "call";
+    name: string;
+    args: readonly DataviewExpression[];
+};
+export type DataviewSpec = {
+    type: DataviewQueryType;
+    columns: readonly DataviewColumn[];
+    expression: string | null;
+    from: DataviewFrom | null;
+    where: DataviewExpression | null;
+    sort: readonly DataviewSort[];
+    groupBy: string | null;
+    limit: number | null;
+};
+export type DataviewParseResult = {
+    status: "ok";
+    spec: DataviewSpec;
+} | {
+    status: "error";
+    message: string;
+};
+export type DataviewOptions = {
+    className?: string;
+    language?: string;
+    hideFallback?: boolean;
+    limit?: number;
+};
+export type ResolvedDataviewOptions = {
+    className: string;
+    language: string;
+    hideFallback: boolean;
+    limit: number | null;
+};
+export declare const DEFAULT_DATAVIEW_CLASS_NAME = "rb-dataview";
+export declare const DEFAULT_DATAVIEW_LANGUAGE = "dataview";
+export declare function resolveDataviewOptions(options?: DataviewOptions): ResolvedDataviewOptions;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@riebeckite/plugin-dataview",
+  "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",
+    "@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/dataview"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Build-time dataview queries for Riebeckite content.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "dataview",
+    "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,192 @@
+.rb-dataview {
+  --rb-dataview-ink: var(--rb-color-ink, #000000);
+  --rb-dataview-paper: var(--rb-color-paper, #ffffff);
+  --rb-dataview-muted: var(--rb-color-muted, #69645c);
+  --rb-dataview-accent: var(--rb-color-accent, #686868);
+  --rb-dataview-rule: var(
+    --rb-color-border,
+    color-mix(in srgb, var(--rb-dataview-ink) 18%, transparent)
+  );
+  --rb-dataview-surface: color-mix(
+    in srgb,
+    var(--rb-dataview-paper) 94%,
+    var(--rb-dataview-ink)
+  );
+
+  margin: 1.5rem 0;
+  color: var(--rb-dataview-ink);
+}
+
+.rb-dataview__table,
+.rb-dataview__calendar {
+  width: 100%;
+  border-collapse: collapse;
+  font-size: 0.9375rem;
+}
+
+.rb-dataview__heading,
+.rb-dataview__calendar-weekday {
+  padding: 0.5rem 0.75rem;
+  border-bottom: 1px solid var(--rb-dataview-ink);
+  text-align: left;
+  font-weight: 700;
+}
+
+.rb-dataview__cell,
+.rb-dataview__calendar-cell {
+  padding: 0.5rem 0.75rem;
+  vertical-align: top;
+}
+
+.rb-dataview__row:not(:last-child) .rb-dataview__cell {
+  border-bottom: 1px solid var(--rb-dataview-rule);
+}
+
+.rb-dataview__group {
+  margin: 1rem 0 0.25rem;
+  font-size: 0.8125rem;
+  font-weight: 700;
+  letter-spacing: 0.04em;
+  text-transform: uppercase;
+  color: var(--rb-dataview-muted);
+}
+
+.rb-dataview__group-cell {
+  padding: 0.5rem 0.75rem;
+  border-bottom: 1px solid var(--rb-dataview-ink);
+  text-align: left;
+  font-weight: 700;
+}
+
+.rb-dataview__link {
+  color: inherit;
+  text-decoration: underline;
+  text-decoration-color: var(--rb-dataview-rule);
+  text-underline-offset: 0.2em;
+}
+
+.rb-dataview__link:hover,
+.rb-dataview__link:focus-visible {
+  text-decoration-color: var(--rb-dataview-accent);
+}
+
+.rb-dataview__tag {
+  display: inline-block;
+  margin-right: 0.25rem;
+  color: var(--rb-dataview-muted);
+  font-size: 0.8125em;
+  white-space: nowrap;
+}
+
+.rb-dataview__list,
+.rb-dataview__tasks {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+.rb-dataview__item,
+.rb-dataview__task {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 0.5rem;
+  align-items: baseline;
+  padding: 0.5rem 0;
+  border-bottom: 1px solid var(--rb-dataview-rule);
+}
+
+.rb-dataview__item:last-child,
+.rb-dataview__task:last-child {
+  border-bottom: 0;
+}
+
+.rb-dataview__meta {
+  color: var(--rb-dataview-muted);
+  font-size: 0.8125em;
+}
+
+.rb-dataview__task[data-task="x"] .rb-dataview__task-text {
+  color: var(--rb-dataview-muted);
+  text-decoration: line-through;
+}
+
+.rb-dataview__task::before {
+  content: "☐";
+  color: var(--rb-dataview-muted);
+}
+
+.rb-dataview__task[data-task="x"]::before {
+  content: "☑";
+}
+
+.rb-dataview__task-link {
+  color: var(--rb-dataview-muted);
+  font-size: 0.8125em;
+  text-decoration: underline;
+  text-underline-offset: 0.2em;
+}
+
+.rb-dataview__calendar-caption {
+  padding-bottom: 0.5rem;
+  text-align: left;
+  font-weight: 700;
+}
+
+.rb-dataview__calendar-cell {
+  border: 1px solid var(--rb-dataview-rule);
+  min-width: 4rem;
+  height: 4rem;
+}
+
+.rb-dataview__calendar-cell--empty {
+  background: var(--rb-dataview-surface);
+}
+
+.rb-dataview__calendar-day {
+  display: block;
+  font-size: 0.75rem;
+  color: var(--rb-dataview-muted);
+}
+
+.rb-dataview__calendar-links {
+  display: block;
+  font-size: 0.8125rem;
+}
+
+.rb-dataview__empty {
+  margin: 1.5rem 0;
+  color: var(--rb-dataview-muted);
+  font-style: italic;
+}
+
+.rb-dataview__fallback {
+  margin-top: 0.75rem;
+  color: var(--rb-dataview-muted);
+  font-size: 0.8125rem;
+}
+
+.rb-dataview__fallback-summary {
+  cursor: pointer;
+}
+
+.rb-dataview__fallback-code {
+  overflow-x: auto;
+  margin: 0.5rem 0 0;
+  padding: 0.75rem 1rem;
+  border: 1px solid var(--rb-dataview-rule);
+  background: var(--rb-dataview-surface);
+}
+
+.rb-dataview--error {
+  margin: 1.5rem 0;
+  padding: 0.75rem 1rem;
+  border: 1px solid var(--rb-dataview-ink);
+  background: var(--rb-dataview-surface);
+  font-size: 0.875rem;
+}
+
+html[data-theme="dark"] .rb-dataview,
+html.dark .rb-dataview {
+  --rb-dataview-ink: var(--rb-color-paper, #ffffff);
+  --rb-dataview-paper: var(--rb-color-ink, #000000);
+}