@lapis-notes/api 0.1.3 → 0.1.4

package/dist/file-editing-sessions.js

@@ -0,0 +1,197 @@
+function filePath(path) {
+    if (typeof path !== "string" || /[\\\0]/u.test(path))
+        throw new Error("Editing sessions require a vault-relative file path");
+    const parts = path
+        .replace(/^\/+/, "")
+        .split("/")
+        .filter((part) => part !== "." && part !== "");
+    if (!parts.length || parts.some((part) => part === ".."))
+        throw new Error("Editing sessions require a vault-relative file path");
+    return parts.join("/");
+}
+function throwFailures(errors) {
+    if (errors.length === 1)
+        throw errors[0];
+    if (errors.length)
+        throw new AggregateError(errors, "File editing-session cleanup failed");
+}
+function failures(results) {
+    return results.flatMap((result) => result.status === "rejected" ? [result.reason] : []);
+}
+/**
+ * An App-owned persistence and protection boundary for independent file writers.
+ * Hosts must register every writer before selecting this as an apply guard.
+ */
+export class FileEditingSessionRegistry {
+    #sessions = new Map();
+    #barriers = new Map();
+    #releases = new Set();
+    #held = new Set();
+    #tail = Promise.resolve();
+    #closing = false;
+    #closed = false;
+    #disposal;
+    register(path, session) {
+        this.#assertOpen();
+        const capturedPath = filePath(path);
+        if ([...this.#barriers.values()].some((scope) => scope === undefined || scope === capturedPath))
+            throw new Error(`File editing is protected: ${capturedPath}`);
+        if (!session ||
+            typeof session.flush !== "function" ||
+            typeof session.protect !== "function" ||
+            typeof session.dirty !== "boolean")
+            throw new Error("Invalid file editing session");
+        let entry = this.#sessions.get(session);
+        if (entry && entry.path !== capturedPath)
+            throw new Error("An editing session cannot change its registered file");
+        if (!entry) {
+            entry = { path: capturedPath, session, references: 0 };
+            this.#sessions.set(session, entry);
+        }
+        entry.references++;
+        let registered = true;
+        return () => {
+            if (!registered)
+                return;
+            registered = false;
+            entry.references--;
+            this.#prune(entry);
+        };
+    }
+    /** Flush the captured sessions; protection is required for mutation admission. */
+    async flush(path) {
+        this.#assertOpen();
+        const scope = path === undefined ? undefined : filePath(path);
+        return this.#enqueue(async () => {
+            const entries = this.#matching(scope);
+            const results = await Promise.allSettled(entries.map(async (entry) => {
+                await entry.session.flush();
+                if (entry.session.dirty)
+                    throw new Error(`File editing session remains dirty: ${entry.path}`);
+                this.#prune(entry);
+            }));
+            throwFailures(failures(results));
+            return {
+                flushed: entries.length > 0,
+                ...(scope === undefined ? {} : { path: scope }),
+            };
+        });
+    }
+    /**
+     * Serialize mutations, holding matching sessions protected throughout the callback.
+     * Callbacks and session methods must not re-enter queued registry operations.
+     */
+    guard(path, operation) {
+        try {
+            this.#assertOpen();
+            const scope = path === undefined ? undefined : filePath(path);
+            return this.#enqueue(() => this.#guard(scope, operation));
+        }
+        catch (error) {
+            return Promise.reject(error);
+        }
+    }
+    /** Stop admission immediately, drain callbacks and retry failed persistence/cleanup. */
+    dispose() {
+        if (this.#disposal)
+            return this.#disposal;
+        this.#closing = true;
+        this.#disposal = (async () => {
+            await this.#tail;
+            if (this.#closed)
+                return;
+            await this.#guard(undefined, async () => undefined, true);
+            this.#sessions.clear();
+            this.#closed = true;
+        })();
+        // Keep closure permanent, but allow explicitly requested cleanup retries.
+        void this.#disposal.catch(() => {
+            this.#disposal = undefined;
+        });
+        return this.#disposal;
+    }
+    #assertOpen() {
+        if (this.#closing)
+            throw new Error("File editing-session registry is closed");
+    }
+    #enqueue(operation) {
+        const run = this.#tail.then(() => {
+            this.#assertOpen();
+            return operation();
+        });
+        this.#tail = run.then(() => undefined, () => undefined);
+        return run;
+    }
+    #matching(path) {
+        return [...this.#sessions.values()].filter((entry) => path === undefined || entry.path === path);
+    }
+    #prune(entry) {
+        // A detached writer's failed or in-flight persistence remains a barrier.
+        if (entry.references ||
+            this.#held.has(entry) ||
+            this.#sessions.get(entry.session) !== entry)
+            return;
+        try {
+            if (!entry.session.dirty)
+                this.#sessions.delete(entry.session);
+        }
+        catch {
+            // A failing dirty-state getter must not silently remove a writer.
+        }
+    }
+    async #release(pending) {
+        const results = await Promise.allSettled(pending.map(async (lease) => {
+            await lease.release();
+            this.#releases.delete(lease);
+            this.#held.delete(lease.entry);
+            this.#prune(lease.entry);
+        }));
+        for (const barrier of this.#barriers.keys())
+            if (![...this.#releases].some((lease) => lease.barrier === barrier))
+                this.#barriers.delete(barrier);
+        return failures(results);
+    }
+    async #guard(path, operation, shutdown = false) {
+        // A previous release failure must be repaired before another mutation starts.
+        throwFailures(await this.#release([...this.#releases]));
+        const barrier = {};
+        this.#barriers.set(barrier, path);
+        const entries = this.#matching(path);
+        for (const entry of entries)
+            this.#held.add(entry);
+        let result;
+        const errors = [];
+        try {
+            const protectedEntries = [];
+            const admission = await Promise.allSettled(entries.map(async (entry) => {
+                const release = await entry.session.protect();
+                if (typeof release !== "function")
+                    throw new Error("Invalid editing-session protection release");
+                this.#releases.add({ barrier, entry, release });
+                protectedEntries.push(entry);
+            }));
+            const saved = await Promise.allSettled(protectedEntries.map(async (entry) => {
+                await entry.session.flush();
+                if (entry.session.dirty)
+                    throw new Error(`File editing session remains dirty: ${entry.path}`);
+                this.#prune(entry);
+            }));
+            throwFailures([...failures(admission), ...failures(saved)]);
+            if (!shutdown)
+                this.#assertOpen();
+            result = await operation();
+        }
+        catch (error) {
+            errors.push(error);
+        }
+        errors.push(...(await this.#release([...this.#releases].filter((lease) => lease.barrier === barrier))));
+        for (const entry of entries) {
+            if (![...this.#releases].some((lease) => lease.entry === entry)) {
+                this.#held.delete(entry);
+                this.#prune(entry);
+            }
+        }
+        throwFailures(errors);
+        return result;
+    }
+}

package/dist/file-manager.d.ts

@@ -41,6 +41,7 @@ export declare class FileManager {
      * @public
      */
     renameFile(file: TAbstractFile, newPath: string): Promise<void>;
+    private renameProtectedFile;
     /**
      * Remove a file or a folder from the vault according the user's preferred
      * 'trash' options (either moving the file to .trash/ or the OS trash bin).

package/dist/file-manager.js

@@ -173,6 +173,14 @@ export class FileManager {
      * @public
      */
     async renameFile(file, newPath) {
+        const capturedPath = file.path;
+        await this.app.fileEditingSessions.guard(undefined, async () => {
+            if (file.path !== capturedPath)
+                throw new Error("Rename target changed during editor admission");
+            await this.renameProtectedFile(file, newPath);
+        });
+    }
+    async renameProtectedFile(file, newPath) {
         if (!(file instanceof TFile)) {
             return this.app.vault.rename(file, newPath);
         }

package/dist/generated/plugin-host-modules.schema.generated.d.ts

@@ -137,7 +137,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/agent-skills": {
         readonly entry: "@lapis-notes/api/agent-skills";
@@ -147,7 +147,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/agent-skills";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/agent-tools": {
         readonly entry: "@lapis-notes/api/agent-tools";
@@ -157,7 +157,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/agent-tools";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/app-database": {
         readonly entry: "@lapis-notes/api/app-database";
@@ -167,7 +167,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/app-database";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/build/vite": {
         readonly entry: "@lapis-notes/api/build/vite";
@@ -177,7 +177,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/build/vite";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/cache": {
         readonly entry: "@lapis-notes/api/cache";
@@ -187,7 +187,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/cache";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/copy-button": {
         readonly entry: "@lapis-notes/api/copy-button";
@@ -197,7 +197,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/copy-button";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/desktop-native": {
         readonly entry: "@lapis-notes/api/desktop-native";
@@ -207,7 +207,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/desktop-native";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor": {
         readonly defaultExport: true;
@@ -218,7 +218,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/core": {
         readonly entry: "@lapis-notes/api/editor/core";
@@ -228,7 +228,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/core";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/extensions/autocomplete": {
         readonly entry: "@lapis-notes/api/editor/extensions/autocomplete";
@@ -238,7 +238,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/extensions/autocomplete";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/extensions/class-highlighter": {
         readonly entry: "@lapis-notes/api/editor/extensions/class-highlighter";
@@ -248,7 +248,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/extensions/class-highlighter";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/extensions/fold-gutter": {
         readonly entry: "@lapis-notes/api/editor/extensions/fold-gutter";
@@ -258,7 +258,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/extensions/fold-gutter";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/extensions/gutter-line-style-sync": {
         readonly entry: "@lapis-notes/api/editor/extensions/gutter-line-style-sync";
@@ -268,7 +268,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/extensions/gutter-line-style-sync";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/extensions/lint": {
         readonly entry: "@lapis-notes/api/editor/extensions/lint";
@@ -278,7 +278,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/extensions/lint";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/extensions/search": {
         readonly entry: "@lapis-notes/api/editor/extensions/search";
@@ -288,7 +288,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/extensions/search";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/editor/language-service": {
         readonly entry: "@lapis-notes/api/editor/language-service";
@@ -298,7 +298,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/editor/language-service";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/empty-view": {
         readonly entry: "@lapis-notes/api/empty-view";
@@ -308,7 +308,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/empty-view";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/icon": {
         readonly entry: "@lapis-notes/api/icon";
@@ -318,7 +318,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/icon";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/language-service": {
         readonly entry: "@lapis-notes/api/language-service";
@@ -328,7 +328,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/language-service";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/language-service/worker": {
         readonly entry: "@lapis-notes/api/language-service/worker";
@@ -338,7 +338,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/language-service/worker";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/menu": {
         readonly defaultExport: true;
@@ -349,7 +349,17 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/menu";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
+    };
+    readonly "@lapis-notes/api/metadata-store": {
+        readonly entry: "@lapis-notes/api/metadata-store";
+        readonly moduleId: "lapis-notes-api-metadata-store";
+        readonly packageName: "@lapis-notes/api";
+        readonly platforms: readonly [];
+        readonly public: true;
+        readonly source: "package-json-export";
+        readonly specifier: "@lapis-notes/api/metadata-store";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/metadata-value": {
         readonly entry: "@lapis-notes/api/metadata-value";
@@ -359,7 +369,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/metadata-value";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/path": {
         readonly entry: "@lapis-notes/api/path";
@@ -369,7 +379,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/path";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/plugin-assets": {
         readonly entry: "@lapis-notes/api/plugin-assets";
@@ -379,7 +389,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/plugin-assets";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/plugin-distribution-host": {
         readonly entry: "@lapis-notes/api/plugin-distribution-host";
@@ -389,7 +399,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/plugin-distribution-host";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/plugin-host-modules": {
         readonly entry: "@lapis-notes/api/plugin-host-modules";
@@ -399,7 +409,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/plugin-host-modules";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/registry/schema": {
         readonly entry: "@lapis-notes/api/registry/schema";
@@ -409,7 +419,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/registry/schema";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/search-embedding-worker": {
         readonly entry: "@lapis-notes/api/search-embedding-worker";
@@ -419,7 +429,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/search-embedding-worker";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/select": {
         readonly entry: "@lapis-notes/api/select";
@@ -429,7 +439,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/select";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/server-host": {
         readonly entry: "@lapis-notes/api/server-host";
@@ -439,7 +449,27 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/server-host";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
+    };
+    readonly "@lapis-notes/api/sync-repository": {
+        readonly entry: "@lapis-notes/api/sync-repository";
+        readonly moduleId: "lapis-notes-api-sync-repository";
+        readonly packageName: "@lapis-notes/api";
+        readonly platforms: readonly ["web", "electron-renderer"];
+        readonly public: true;
+        readonly source: "package-json-export";
+        readonly specifier: "@lapis-notes/api/sync-repository";
+        readonly version: "0.1.4";
+    };
+    readonly "@lapis-notes/api/sync-security-host": {
+        readonly entry: "@lapis-notes/api/sync-security-host";
+        readonly moduleId: "lapis-notes-api-sync-security-host";
+        readonly packageName: "@lapis-notes/api";
+        readonly platforms: readonly [];
+        readonly public: true;
+        readonly source: "package-json-export";
+        readonly specifier: "@lapis-notes/api/sync-security-host";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/telemetry": {
         readonly entry: "@lapis-notes/api/telemetry";
@@ -449,7 +479,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/telemetry";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/vault": {
         readonly entry: "@lapis-notes/api/vault";
@@ -459,7 +489,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/vault";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/api/workspace-host": {
         readonly entry: "@lapis-notes/api/workspace-host";
@@ -469,7 +499,7 @@ export declare const pluginHostModuleRegistry: {
         readonly public: true;
         readonly source: "package-json-export";
         readonly specifier: "@lapis-notes/api/workspace-host";
-        readonly version: "0.1.3";
+        readonly version: "0.1.4";
     };
     readonly "@lapis-notes/markdown": {
         readonly entry: "@lapis-notes/markdown";