@lapis-notes/api 0.1.3 → 0.2.0

package/dist/plugin.d.ts

@@ -1,3 +1,6 @@
+import type { IconLoader } from "./icons";
+import type { ExtensionRegistrationOptions } from "./editor-view-registry";
+import type { SearchResultProvider, SearchResultProviderRegistration } from "./search-result-provider";
 import type { MetadataProcessor } from "./cache.svelte";
 import type { IndexProjectionRegistration, RegisteredIndexProjectionHandle } from "./storage/index-projection";
 import type { SearchDocumentProvider, SearchDocumentProviderRegistration } from "./search-document-provider";
@@ -5,6 +8,7 @@ import type { Command, KeymapEventHandler } from "./command.svelte";
 import type { ContextKeyValue, ScopedContextKey } from "./context-keys.svelte";
 import type { App, ExtType } from "./context.svelte";
 import type { LapisExtensionContributions, LapisExtensionKind, LapisExtensionManifest, LapisExtensionPermission, LapisExtensionRuntimeHost, LapisPluginClassification, LapisServiceProviderRegistration, LapisSystemExtensionRegistration } from "./lapis-extension";
+import type { MarkdownEmbedder } from "./embed-registry";
 import type { EditorViewContribution } from "./editor-view-registry";
 import type { ConfigurationOptionSourceProvider, ConfigurationOptionSourceRegistration } from "./configuration-option-source-registry";
 import type { HostedPluginCapability } from "./plugin-capability-facade";
@@ -125,6 +129,8 @@ export interface PluginManifest {
      * @public
      */
     requiredCapabilities?: HostedPluginCapability[];
+    /** Native host services that must be available before module evaluation. */
+    requiredNativeServices?: string[];
     /**
      * Optional host-specific execution hints for future sidecar scheduling.
      *
@@ -150,7 +156,7 @@ export type PluginSource = "core" | "community" | "official" | "system";
  * Resolve the compatibility data path used by `loadData()` and `saveData()`.
  *
  * Community plugins store data beside their manifest folder, while bundled and
- * system plugins use the shared `/.obsidian/<id>.json` location.
+ * system plugins use the shared `/.lapis/<id>.json` location.
  *
  * @public
  */
@@ -171,7 +177,7 @@ export interface PluginRuntimeOptions {
     requestedCapabilities?: HostedPluginCapability[];
     grantedCapabilities?: HostedPluginCapability[];
     createSyncHostCapabilities?: () => SyncHostCapabilities;
-    revokeSyncHostCapabilities?: () => void;
+    revokeSyncHostCapabilities?: () => void | Promise<void>;
 }
 /**
  * Base class for Lapis plugins.
@@ -247,6 +253,8 @@ export declare abstract class Plugin extends Component {
      * @see {@link https://docs.obsidian.md/Plugins/User+interface/Settings}
      */
     loadData(): Promise<any>;
+    private runDataOperation;
+    private loadDataNow;
     /**
      * Write settings data to disk. Data is stored in `data.json` in the plugin
      * folder.
@@ -255,6 +263,7 @@ export declare abstract class Plugin extends Component {
      * @see {@link https://docs.obsidian.md/Plugins/User+interface/Settings}
      */
     saveData(data: any): Promise<void>;
+    private saveDataNow;
     loadGeneratedState<T>(key: string): Promise<T | null>;
     saveGeneratedState(key: string, value: unknown): Promise<void>;
     deleteGeneratedState(key: string): Promise<void>;
@@ -280,6 +289,10 @@ export declare abstract class Plugin extends Component {
         icon?: string;
         hidden?: boolean;
     }, access?: ViewAccess): void;
+    /** Register an App-owned SVG and dispose it automatically on plugin unload. */
+    registerIcon(localId: string, svg: string): string;
+    /** Register an owned icon pack; use the returned prefix in `prefix:icon` IDs. */
+    registerIconPack(input: IconLoader): string;
     registerEditorView(contribution: EditorViewContribution): void;
     registerConfigurationOptionSource(id: string, provider: Omit<ConfigurationOptionSourceProvider, "pluginId">): ConfigurationOptionSourceRegistration;
     registerHoverLinkSource(id: string, info: any): void;
@@ -291,7 +304,7 @@ export declare abstract class Plugin extends Component {
     createDiagnosticCollection(id: string, options?: DiagnosticCollectionOptions): DiagnosticCollection;
     onUserEnable(): Promise<void> | void;
     onExternalSettingsChange(): Promise<void> | void;
-    registerExtensions(extensions: string[], viewType?: string): void;
+    registerExtensions(extensions: string[], viewType?: string, options?: ExtensionRegistrationOptions): void;
     registerTypeWidget(widget: TypeWidget): void;
     /**
      * Register an EditorSuggest which can provide live suggestions while the user
@@ -326,6 +339,7 @@ export declare abstract class Plugin extends Component {
     registerMarkdownCodeBlockProcessor(language: string, handler: (source: string, el: HTMLElement, ctx: MarkdownPostProcessorContext) => Promise<any> | void, sortOrder?: number): MarkdownPostProcessor;
     registerMarkdownDirectiveRenderer(directive: string, renderer: MarkdownDirectiveRenderer): void;
     registerMarkdownViewMenuItem(provider: MarkdownViewMenuItemProvider): void;
+    registerMarkdownEmbedder(embedder: MarkdownEmbedder): void;
     registerMetadataProcessor(processor: MetadataProcessor, ext?: string): void;
     registerIndexProjection<T = Record<string, unknown>>(registration: IndexProjectionRegistration): RegisteredIndexProjectionHandle<T>;
     private backfillIndexProjection;
@@ -334,6 +348,8 @@ export declare abstract class Plugin extends Component {
      * The local id is namespaced by this plugin's runtime id.
      */
     registerSearchDocumentProvider(localId: string, provider: Omit<SearchDocumentProvider, "id">): SearchDocumentProviderRegistration;
+    /** Contribute query results whose navigation remains provider-owned. */
+    registerSearchResultProvider(localId: string, provider: Omit<SearchResultProvider, "id">): SearchResultProviderRegistration;
     /** Register an application tool under this plugin's lifecycle and identity. */
     registerAgentTool<TInput>(tool: AppTool<TInput>): AppToolRegistration;
     /** Register a directory that contains one skill. */

package/dist/plugin.js

@@ -1,3 +1,5 @@
+import { saveFileState } from "./file-state-store";
+import { appStatePath } from "./storage/path";
 import { matchesProjectionSource } from "./storage/index-projection";
 import { resolveWorkspaceHostBinding } from "./workspace-host-internal";
 import { dirname, joinPath } from "./storage";
@@ -9,13 +11,13 @@ function isPromiseLike(value) {
  * Resolve the compatibility data path used by `loadData()` and `saveData()`.
  *
  * Community plugins store data beside their manifest folder, while bundled and
- * system plugins use the shared `/.obsidian/<id>.json` location.
+ * system plugins use the shared `/.lapis/<id>.json` location.
  *
  * @public
  */
 export function resolvePluginDataPath(pluginId, source, basePath) {
     if (source === "core" || source === "system") {
-        return joinPath("/.obsidian", `${pluginId}.json`);
+        return joinPath("/", appStatePath(`${pluginId}.json`));
     }
     if (!basePath) {
         return null;
@@ -122,10 +124,19 @@ export class Plugin extends Component {
                 this.register(() => lease.release());
             }
             await this.loadAsync();
+            await this.app.metadataCache?.finishNativeContributions?.(this.id);
             this.#runtimeState = "enabled";
             this.emit("enable");
         }
         catch (error) {
+            if (this.app.session?.backgroundIndexing && this.loaded) {
+                try {
+                    await this.unloadAsync();
+                }
+                catch (cleanupError) {
+                    console.error("Failed to rollback native plugin activation", cleanupError);
+                }
+            }
             this.#runtimeState = "failed";
             this.#failureMessage = formatPluginError(error);
             this.#lastFailureMessage = this.#failureMessage;
@@ -200,6 +211,10 @@ export class Plugin extends Component {
             return;
         }
         const payload = JSON.stringify(data, null, 2);
+        if (this.app.vault.supportsConditionalTextWrites) {
+            await saveFileState(this.app, path, payload);
+            return;
+        }
         const file = this.app.vault.getFileByPath(path);
         if (file) {
             await this.app.vault.modify(file, payload);
@@ -236,17 +251,31 @@ export class Plugin extends Component {
     }
     async disable() {
         if (!this.loaded) {
-            this.#revokeSyncHostCapabilities?.();
-            this.#syncHostCapabilities = null;
+            try {
+                await this.app.metadataCache?.disableNativeContributions?.(this.id);
+                await this.#revokeSyncHostCapabilities?.();
+            }
+            finally {
+                this.#syncHostCapabilities = null;
+            }
             this.#runtimeState = "disabled";
             this.#failureMessage = null;
             return;
         }
         this.#runtimeState = "disabling";
         try {
-            await this.unloadAsync();
-            this.#revokeSyncHostCapabilities?.();
-            this.#syncHostCapabilities = null;
+            await this.app.metadataCache?.disableNativeContributions?.(this.id);
+            try {
+                await this.unloadAsync();
+            }
+            finally {
+                try {
+                    await this.#revokeSyncHostCapabilities?.();
+                }
+                finally {
+                    this.#syncHostCapabilities = null;
+                }
+            }
             this.#runtimeState = "disabled";
             this.#failureMessage = null;
             this.emit("disable");
@@ -260,27 +289,17 @@ export class Plugin extends Component {
         }
     }
     addStatusBarItem() {
-        let parent = this.app.workspace.statusCompatEl ??
-            document.querySelector("#status-bar");
-        if (!parent) {
-            parent = document.querySelector("#lapis-status-bar-compat-fallback");
-        }
-        if (!parent) {
-            parent = document.body.createDiv({
-                attr: {
-                    id: "lapis-status-bar-compat-fallback",
-                    hidden: "true",
-                    "aria-hidden": "true",
-                },
-            });
-        }
-        this.app.workspace.statusCompatEl = parent;
-        const statusEl = parent.createDiv({
-            cls: "status-bar-item plugin-" + this.manifest.id,
-        });
-        this.register(() => {
-            statusEl.detach();
+        const statusEl = document.createElement("div");
+        statusEl.className = "status-bar-item plugin-" + this.manifest.id;
+        const dispose = this.app.statusBar.registerItem({
+            id: `${this.manifest.id}:compat-status:${crypto.randomUUID()}`,
+            sourcePlugin: this.manifest.id,
+            mount: (host) => {
+                host.append(statusEl);
+                return () => statusEl.remove();
+            },
         });
+        this.register(dispose);
         return statusEl;
     }
     /**
@@ -291,6 +310,14 @@ export class Plugin extends Component {
      * @see {@link https://docs.obsidian.md/Plugins/User+interface/Settings}
      */
     loadData() {
+        return this.runDataOperation(() => this.loadDataNow());
+    }
+    runDataOperation(run) {
+        return this.app.vault.supportsConditionalTextWrites
+            ? this.app.fileEditingSessions.track(run)
+            : run();
+    }
+    loadDataNow() {
         return this.measureTelemetryAsync("plugin.load_data", async () => {
             if (this.app.configuration.hasPluginData(this.id)) {
                 const data = this.app.configuration.getPluginData(this.id);
@@ -312,6 +339,9 @@ export class Plugin extends Component {
      * @see {@link https://docs.obsidian.md/Plugins/User+interface/Settings}
      */
     saveData(data) {
+        return this.runDataOperation(() => this.saveDataNow(data));
+    }
+    saveDataNow(data) {
         return this.measureTelemetryAsync("plugin.save_data", async () => {
             await this.app.configuration.updatePluginData(this.id, data, {
                 origin: "plugin-save",
@@ -437,6 +467,18 @@ export class Plugin extends Component {
             this.app.workspace.unregisterSidebarView(type);
         });
     }
+    /** Register an App-owned SVG and dispose it automatically on plugin unload. */
+    registerIcon(localId, svg) {
+        const registration = this.app.icons.registerIcon(this.manifest.id, localId, svg);
+        this.register(registration.dispose);
+        return registration.id;
+    }
+    /** Register an owned icon pack; use the returned prefix in `prefix:icon` IDs. */
+    registerIconPack(input) {
+        const registration = this.app.icons.registerIconPack(this.manifest.id, input);
+        this.register(registration.dispose);
+        return registration.prefix;
+    }
     registerEditorView(contribution) {
         const dispose = this.app.workspace.registerEditorView({
             ...contribution,
@@ -491,7 +533,11 @@ export class Plugin extends Component {
     }
     onUserEnable() { }
     onExternalSettingsChange() { }
-    registerExtensions(extensions, viewType = "markdown") {
+    registerExtensions(extensions, viewType = "markdown", options) {
+        if (options) {
+            this.register(this.app.workspace.registerExtensions(extensions, viewType, options));
+            return;
+        }
         this.app.workspace.registerExtensions(extensions, viewType);
         this.register(() => {
             this.app.workspace.unregisterExtensions(extensions, viewType);
@@ -607,29 +653,38 @@ export class Plugin extends Component {
             this.app.unregisterMarkdownViewMenuItem(provider);
         });
     }
+    registerMarkdownEmbedder(embedder) {
+        this.register(this.app.embedRegistry.registerMarkdownEmbedder(embedder));
+    }
     registerMetadataProcessor(processor, ext = "md") {
-        this.app.metadataCache.addProcessor(ext, processor);
+        this.app.metadataCache.addProcessor(ext, processor, this.id);
         this.register(() => {
             this.app.metadataCache.removeProcessor(ext, processor);
         });
     }
     registerIndexProjection(registration) {
         const recorded = this.app.indexProjections.register(this.id, registration);
-        void this.app.appDatabase.registerProjectionDefinition({
-            projectionId: recorded.projectionId,
-            ownerPluginId: this.id,
-            schemaVersion: registration.version,
-            configHash: registration.configurationHash ?? "",
-            visibility: registration.visibility ?? "public",
-            fields: registration.fields,
-            active: true,
-            updatedAt: Date.now(),
-        });
-        this.register(() => {
-            this.app.indexProjections.unregister(recorded.projectionId);
-            void this.app.appDatabase.unregisterProjectionDefinition(recorded.projectionId);
-        });
-        void this.backfillIndexProjection(recorded.projectionId);
+        if (this.app.session?.backgroundIndexing) {
+            this.app.metadataCache.registerNativeProjection(this.id, recorded.projectionId, registration);
+            this.register(() => this.app.indexProjections.unregister(recorded.projectionId));
+        }
+        else {
+            void this.app.appDatabase.registerProjectionDefinition({
+                projectionId: recorded.projectionId,
+                ownerPluginId: this.id,
+                schemaVersion: registration.version,
+                configHash: registration.configurationHash ?? "",
+                visibility: registration.visibility ?? "public",
+                fields: registration.fields,
+                active: true,
+                updatedAt: Date.now(),
+            });
+            this.register(() => {
+                this.app.indexProjections.unregister(recorded.projectionId);
+                void this.app.appDatabase.unregisterProjectionDefinition(recorded.projectionId);
+            });
+            void this.backfillIndexProjection(recorded.projectionId);
+        }
         return {
             id: recorded.projectionId,
             query: (query) => this.app.appDatabase.queryProjection(recorded.projectionId, query, this.id),
@@ -698,6 +753,17 @@ export class Plugin extends Component {
         this.register(() => registration.dispose());
         return registration;
     }
+    /** Contribute query results whose navigation remains provider-owned. */
+    registerSearchResultProvider(localId, provider) {
+        if (!localId.trim())
+            throw new Error("Search result provider local id must not be empty.");
+        const registration = this.app.searchResultProviders.register({
+            ...provider,
+            id: `${this.id}:${localId.trim()}`,
+        });
+        this.register(() => registration.dispose());
+        return registration;
+    }
     /** Register an application tool under this plugin's lifecycle and identity. */
     registerAgentTool(tool) {
         const registration = this.app.agentTools.register({