@lapis-notes/history 0.1.0

package/dist/history-view.js

@@ -0,0 +1,36 @@
+import { View } from "@lapis-notes/api";
+import { mount, unmount } from "svelte";
+import HistoryPanel from "./history-panel.svelte";
+import { HistoryViewType } from "./history-view-type";
+export class HistoryView extends View {
+    component = null;
+    constructor(leaf) {
+        super(leaf);
+    }
+    getViewType() {
+        return HistoryViewType;
+    }
+    getDisplayText() {
+        return "History";
+    }
+    getIcon() {
+        return "history";
+    }
+    onOpen() {
+        return Promise.resolve();
+    }
+    onClose() {
+        return Promise.resolve();
+    }
+    onload() {
+        this.component = mount(HistoryPanel, {
+            target: this.containerEl,
+            props: { app: this.app },
+        });
+    }
+    onunload() {
+        if (this.component)
+            void unmount(this.component);
+        this.component = null;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import "./styles.css";
+export { default as manifest } from "../../manifest.json";
+export { HistoryComparePanel, HistoryPanel } from "./public-components";
+export { HISTORY_PLUGIN_ID, HistoryPlugin, } from "./history-plugin";
+export type { HistoryCaptureEventType, HistoryCompareAnchor, HistoryCompareMode, HistoryCompareViewState, HistoryComparisonModel, HistoryFileHistory, HistoryRevision, HistoryViewModel, } from "./history-plugin";
+export { DEFAULT_HISTORY_EXCLUDE_GLOBS, DEFAULT_HISTORY_SETTINGS, mergeHistorySettings, patchHistorySettings, } from "./history-settings";
+export type { HistoryPluginSettings, HistoryPluginSettingsPatch, } from "./history-settings";
+export { HISTORY_SETTING_IDS, HISTORY_SETTINGS_SECTION_ID, createHistorySettingsSection, historyFieldValuesToPatch, historySettingsToFieldValues, registerHistorySettings, } from "./register-history-settings";
+export { HistoryCompareView } from "./history-compare-view";
+export { HistoryView } from "./history-view";
+export { HistoryCompareViewType, HistoryViewType, } from "./history-view-type";

package/dist/index.js

@@ -0,0 +1,9 @@
+import "./styles.css";
+export { default as manifest } from "../../manifest.json";
+export { HistoryComparePanel, HistoryPanel } from "./public-components";
+export { HISTORY_PLUGIN_ID, HistoryPlugin, } from "./history-plugin";
+export { DEFAULT_HISTORY_EXCLUDE_GLOBS, DEFAULT_HISTORY_SETTINGS, mergeHistorySettings, patchHistorySettings, } from "./history-settings";
+export { HISTORY_SETTING_IDS, HISTORY_SETTINGS_SECTION_ID, createHistorySettingsSection, historyFieldValuesToPatch, historySettingsToFieldValues, registerHistorySettings, } from "./register-history-settings";
+export { HistoryCompareView } from "./history-compare-view";
+export { HistoryView } from "./history-view";
+export { HistoryCompareViewType, HistoryViewType, } from "./history-view-type";

package/dist/public-components.d.ts

@@ -0,0 +1,2 @@
+export { default as HistoryPanel } from "./history-panel.svelte";
+export { default as HistoryComparePanel } from "./history-compare-panel.svelte";

package/dist/public-components.js

@@ -0,0 +1,2 @@
+export { default as HistoryPanel } from "./history-panel.svelte";
+export { default as HistoryComparePanel } from "./history-compare-panel.svelte";

package/dist/register-history-settings.d.ts

@@ -0,0 +1,105 @@
+import type { Plugin } from "@lapis-notes/api";
+import type { HistoryPlugin } from "./history-plugin";
+import { type HistoryPluginSettings, type HistoryPluginSettingsPatch } from "./history-settings";
+export declare const HISTORY_SETTING_IDS: {
+    readonly excludeGlobs: "history.excludeGlobs";
+    readonly includeGlobs: "history.includeGlobs";
+    readonly trackedExtensions: "history.trackedExtensions";
+    readonly retentionCount: "history.retentionCount";
+    readonly maxFileSizeKib: "history.maxFileSizeKib";
+    readonly mergeWindowSeconds: "history.mergeWindowSeconds";
+    readonly debounceMs: "history.debounceMs";
+};
+export declare const HISTORY_SETTINGS_SECTION_ID = "history";
+export interface HistorySettingsFieldValues {
+    [HISTORY_SETTING_IDS.excludeGlobs]: string[];
+    [HISTORY_SETTING_IDS.includeGlobs]: string[];
+    [HISTORY_SETTING_IDS.trackedExtensions]: string[];
+    [HISTORY_SETTING_IDS.retentionCount]: number;
+    [HISTORY_SETTING_IDS.maxFileSizeKib]: number;
+    [HISTORY_SETTING_IDS.mergeWindowSeconds]: number;
+    [HISTORY_SETTING_IDS.debounceMs]: number;
+}
+export declare function historySettingsToFieldValues(settings: HistoryPluginSettings): HistorySettingsFieldValues;
+export declare function historyFieldValuesToPatch(values: Record<string, unknown>): HistoryPluginSettingsPatch;
+export declare function createHistorySettingsSection(): {
+    id: string;
+    title: string;
+    description: string;
+    icon: "history";
+    order: number;
+    navigationGroupId: string;
+    sourcePluginId: string;
+    fields: ({
+        id: "history.excludeGlobs";
+        type: "list";
+        itemType: "string";
+        title: string;
+        description: string;
+        default: string[];
+        minimum?: undefined;
+        maximum?: undefined;
+        step?: undefined;
+    } | {
+        id: "history.includeGlobs";
+        type: "list";
+        itemType: "string";
+        title: string;
+        description: string;
+        default: string[];
+        minimum?: undefined;
+        maximum?: undefined;
+        step?: undefined;
+    } | {
+        id: "history.trackedExtensions";
+        type: "list";
+        itemType: "string";
+        title: string;
+        description: string;
+        default: string[];
+        minimum?: undefined;
+        maximum?: undefined;
+        step?: undefined;
+    } | {
+        id: "history.retentionCount";
+        type: "integer";
+        title: string;
+        description: string;
+        default: number;
+        minimum: number;
+        maximum: number;
+        step: number;
+        itemType?: undefined;
+    } | {
+        id: "history.maxFileSizeKib";
+        type: "integer";
+        title: string;
+        description: string;
+        default: number;
+        minimum: number;
+        maximum: number;
+        step: number;
+        itemType?: undefined;
+    } | {
+        id: "history.mergeWindowSeconds";
+        type: "integer";
+        title: string;
+        description: string;
+        default: number;
+        minimum: number;
+        maximum: number;
+        step: number;
+        itemType?: undefined;
+    } | {
+        id: "history.debounceMs";
+        type: "integer";
+        title: string;
+        description: string;
+        default: number;
+        minimum: number;
+        maximum: number;
+        step: number;
+        itemType?: undefined;
+    })[];
+};
+export declare function registerHistorySettings(plugin: HistoryPlugin & Plugin): void;

package/dist/register-history-settings.js

@@ -0,0 +1,199 @@
+import { getWorkspaceHostBinding } from "@lapis-notes/api/workspace-host";
+import { DEFAULT_HISTORY_SETTINGS, patchHistorySettings, } from "./history-settings";
+export const HISTORY_SETTING_IDS = {
+    excludeGlobs: "history.excludeGlobs",
+    includeGlobs: "history.includeGlobs",
+    trackedExtensions: "history.trackedExtensions",
+    retentionCount: "history.retentionCount",
+    maxFileSizeKib: "history.maxFileSizeKib",
+    mergeWindowSeconds: "history.mergeWindowSeconds",
+    debounceMs: "history.debounceMs",
+};
+export const HISTORY_SETTINGS_SECTION_ID = "history";
+function bytesToKib(bytes) {
+    return Math.max(1, Math.round(bytes / 1024));
+}
+function kibToBytes(kib) {
+    return Math.max(1, Math.round(kib) * 1024);
+}
+function msToSeconds(ms) {
+    return Math.max(0, Math.round(ms / 1000));
+}
+function secondsToMs(seconds) {
+    return Math.max(0, Math.round(seconds) * 1000);
+}
+function asStringList(value) {
+    return Array.isArray(value)
+        ? value.filter((entry) => typeof entry === "string")
+        : [];
+}
+function asInteger(value, fallback) {
+    return typeof value === "number" && Number.isFinite(value)
+        ? Math.round(value)
+        : fallback;
+}
+function listsEqual(left, right) {
+    return (left.length === right.length &&
+        left.every((entry, index) => entry === right[index]));
+}
+export function historySettingsToFieldValues(settings) {
+    return {
+        [HISTORY_SETTING_IDS.excludeGlobs]: [...settings.excludeGlobs],
+        [HISTORY_SETTING_IDS.includeGlobs]: [...settings.includeGlobs],
+        [HISTORY_SETTING_IDS.trackedExtensions]: [...settings.trackedExtensions],
+        [HISTORY_SETTING_IDS.retentionCount]: settings.retentionCount,
+        [HISTORY_SETTING_IDS.maxFileSizeKib]: bytesToKib(settings.maxFileSizeBytes),
+        [HISTORY_SETTING_IDS.mergeWindowSeconds]: msToSeconds(settings.mergeWindowMs),
+        [HISTORY_SETTING_IDS.debounceMs]: settings.debounceMs,
+    };
+}
+export function historyFieldValuesToPatch(values) {
+    return {
+        excludeGlobs: asStringList(values[HISTORY_SETTING_IDS.excludeGlobs]),
+        includeGlobs: asStringList(values[HISTORY_SETTING_IDS.includeGlobs]),
+        trackedExtensions: asStringList(values[HISTORY_SETTING_IDS.trackedExtensions]),
+        retentionCount: asInteger(values[HISTORY_SETTING_IDS.retentionCount], DEFAULT_HISTORY_SETTINGS.retentionCount),
+        maxFileSizeBytes: kibToBytes(asInteger(values[HISTORY_SETTING_IDS.maxFileSizeKib], bytesToKib(DEFAULT_HISTORY_SETTINGS.maxFileSizeBytes))),
+        mergeWindowMs: secondsToMs(asInteger(values[HISTORY_SETTING_IDS.mergeWindowSeconds], msToSeconds(DEFAULT_HISTORY_SETTINGS.mergeWindowMs))),
+        debounceMs: asInteger(values[HISTORY_SETTING_IDS.debounceMs], DEFAULT_HISTORY_SETTINGS.debounceMs),
+    };
+}
+export function createHistorySettingsSection() {
+    const defaults = historySettingsToFieldValues(DEFAULT_HISTORY_SETTINGS);
+    return {
+        id: HISTORY_SETTINGS_SECTION_ID,
+        title: "History",
+        description: "Which vault files to snapshot and how long to keep those revisions.",
+        icon: "history",
+        order: 40,
+        navigationGroupId: "core-plugins",
+        sourcePluginId: "history",
+        fields: [
+            {
+                id: HISTORY_SETTING_IDS.excludeGlobs,
+                type: "list",
+                itemType: "string",
+                title: "Exclude globs",
+                description: "Skip matching paths. Clearing the list restores the default .obsidian, .lapis, .git, and .jj excludes.",
+                default: defaults[HISTORY_SETTING_IDS.excludeGlobs],
+            },
+            {
+                id: HISTORY_SETTING_IDS.includeGlobs,
+                type: "list",
+                itemType: "string",
+                title: "Include globs",
+                description: "Optional path allowlist. Leave empty to snapshot remaining paths after excludes.",
+                default: defaults[HISTORY_SETTING_IDS.includeGlobs],
+            },
+            {
+                id: HISTORY_SETTING_IDS.trackedExtensions,
+                type: "list",
+                itemType: "string",
+                title: "Included extensions",
+                description: "Optional extension allowlist without dots. Leave empty to snapshot remaining UTF-8 text under the size cap.",
+                default: defaults[HISTORY_SETTING_IDS.trackedExtensions],
+            },
+            {
+                id: HISTORY_SETTING_IDS.retentionCount,
+                type: "integer",
+                title: "Revisions per file",
+                description: "Maximum stored snapshots for one path.",
+                default: defaults[HISTORY_SETTING_IDS.retentionCount],
+                minimum: 1,
+                maximum: 200,
+                step: 1,
+            },
+            {
+                id: HISTORY_SETTING_IDS.maxFileSizeKib,
+                type: "integer",
+                title: "Maximum file size (KiB)",
+                description: "Files larger than this are not snapshotted.",
+                default: defaults[HISTORY_SETTING_IDS.maxFileSizeKib],
+                minimum: 1,
+                maximum: 2048,
+                step: 1,
+            },
+            {
+                id: HISTORY_SETTING_IDS.mergeWindowSeconds,
+                type: "integer",
+                title: "Merge window (seconds)",
+                description: "Replace the latest modify for the same path when another modify arrives inside this window.",
+                default: defaults[HISTORY_SETTING_IDS.mergeWindowSeconds],
+                minimum: 0,
+                maximum: 120,
+                step: 1,
+            },
+            {
+                id: HISTORY_SETTING_IDS.debounceMs,
+                type: "integer",
+                title: "Capture debounce (ms)",
+                description: "Delay before create and modify snapshots are stored.",
+                default: defaults[HISTORY_SETTING_IDS.debounceMs],
+                minimum: 0,
+                maximum: 5000,
+                step: 50,
+            },
+        ],
+    };
+}
+function fieldValuesEqual(left, right) {
+    if (Array.isArray(left) && Array.isArray(right)) {
+        return (left.length === right.length &&
+            left.every((entry, index) => entry === right[index]));
+    }
+    return left === right;
+}
+const HISTORY_LIST_SETTING_IDS = new Set([
+    HISTORY_SETTING_IDS.excludeGlobs,
+    HISTORY_SETTING_IDS.includeGlobs,
+    HISTORY_SETTING_IDS.trackedExtensions,
+]);
+function applyHistorySettingsToController(controller, settings, options = { lists: true }) {
+    const values = historySettingsToFieldValues(settings);
+    for (const [id, value] of Object.entries(values)) {
+        if (!options.lists && HISTORY_LIST_SETTING_IDS.has(id)) {
+            continue;
+        }
+        if (!fieldValuesEqual(controller.settings.get(id), value)) {
+            controller.settings.update(id, value);
+        }
+    }
+}
+function historySettingsEqual(left, right) {
+    return (left.retentionCount === right.retentionCount &&
+        left.debounceMs === right.debounceMs &&
+        left.mergeWindowMs === right.mergeWindowMs &&
+        left.maxFileSizeBytes === right.maxFileSizeBytes &&
+        listsEqual(left.excludeGlobs, right.excludeGlobs) &&
+        listsEqual(left.includeGlobs, right.includeGlobs) &&
+        listsEqual(left.trackedExtensions, right.trackedExtensions));
+}
+export function registerHistorySettings(plugin) {
+    const binding = getWorkspaceHostBinding(plugin.app.workspace);
+    if (!binding)
+        return;
+    const controller = binding.controller;
+    const settings = plugin.getSettings();
+    plugin.register(controller.registerSettingsSection(createHistorySettingsSection()));
+    applyHistorySettingsToController(controller, settings);
+    const changeRef = controller.settings.on("change", (event) => {
+        if (!event.id || !event.id.startsWith("history."))
+            return;
+        const patch = historyFieldValuesToPatch(controller.settings.getSnapshot().values);
+        const current = plugin.getSettings();
+        const next = patchHistorySettings(current, patch);
+        void (async () => {
+            if (!historySettingsEqual(current, next)) {
+                await plugin.updateSettings(patch);
+            }
+            const saved = plugin.getSettings();
+            applyHistorySettingsToController(controller, saved, { lists: false });
+            const excludeDraft = asStringList(controller.settings.get(HISTORY_SETTING_IDS.excludeGlobs));
+            if (excludeDraft.every((entry) => entry.trim().length === 0) &&
+                listsEqual(saved.excludeGlobs, DEFAULT_HISTORY_SETTINGS.excludeGlobs)) {
+                controller.settings.update(HISTORY_SETTING_IDS.excludeGlobs, saved.excludeGlobs);
+            }
+        })();
+    });
+    plugin.register(() => controller.settings.offref(changeRef));
+}

package/dist/styles.css

@@ -0,0 +1,2 @@
+@import "./history-compare-panel.css";
+@import "./history-panel.css";

package/manifest.json

@@ -0,0 +1,27 @@
+{
+  "id": "history",
+  "name": "History",
+  "version": "0.1.0",
+  "minAppVersion": "0.1.0",
+  "description": "File history",
+  "author": "Lapis Notes",
+  "lapis": {
+    "manifestVersion": 1,
+    "source": "official",
+    "locked": false,
+    "enabledByDefault": true,
+    "runtime": {
+      "entries": {
+        "workspace": {
+          "path": "main.mjs",
+          "format": "esm",
+          "sharedDependencies": [
+            "@lapis-notes/api",
+            "@lapis-notes/api/workspace-host"
+          ],
+          "requiresReloadOnUpdate": false
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@lapis-notes/history",
+  "version": "0.1.0",
+  "description": "Lapis Notes file history plugin",
+  "license": "AGPL-3.0-or-later",
+  "type": "module",
+  "files": [
+    "dist",
+    "manifest.json",
+    "styles.css",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "svelte": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./manifest.json": "./manifest.json",
+    "./styles.css": "./styles.css"
+  },
+  "dependencies": {
+    "@lapis-notes/api": "^0.1.0",
+    "@lapismd/design-core": "^0.1.0",
+    "@lucide/svelte": "^0.523.0"
+  },
+  "peerDependencies": {
+    "svelte": "^5.0.0"
+  },
+  "devDependencies": {
+    "@sveltejs/package": "^2.5.0",
+    "@sveltejs/vite-plugin-svelte": "^5.1.1",
+    "@tsconfig/svelte": "^5.0.5",
+    "publint": "^0.3.12",
+    "svelte": "^5.38.2",
+    "svelte-check": "^4.3.1",
+    "typescript": "~5.8.3",
+    "vite": "^6.4.2",
+    "vitest": "^4.1.8"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lapismd/lapis-plugins.git",
+    "directory": "packages/history"
+  },
+  "homepage": "https://github.com/lapismd/lapis-plugins/tree/main/packages/history#readme",
+  "bugs": {
+    "url": "https://github.com/lapismd/lapis-plugins/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run prepack",
+    "check": "pnpm check:svelte && pnpm check:types",
+    "check:svelte": "svelte-check --tsconfig ./tsconfig.app.json --fail-on-warnings --output human",
+    "check:types": "tsc -p tsconfig.node.json --noEmit",
+    "test": "vitest run --passWithNoTests",
+    "publint": "publint",
+    "pack": "pnpm pack --pack-destination ../../.release/npm"
+  }
+}

package/styles.css

@@ -0,0 +1 @@
+@import "./dist/styles.css";