@lapis-notes/api 0.1.3 → 0.2.0

package/dist/view.svelte.d.ts

@@ -4,7 +4,12 @@ import type { Menu } from "./menu.svelte";
 import { Editor } from "./editor.svelte";
 import type { App } from "./context.svelte";
 import "./enhance";
-import { EventDispatcher, type EventNames, type EventRef, type ValidEventTypes } from "./events";
+import {
+  EventDispatcher,
+  type EventNames,
+  type EventRef,
+  type ValidEventTypes,
+} from "./events";
 import type { Scope } from "./command.svelte";
 /**
  * Base lifecycle helper used throughout the public API.
@@ -14,70 +19,89 @@ import type { Scope } from "./command.svelte";
  *
  * @public
  */
-export declare abstract class Component<Events extends ValidEventTypes = Record<string, any>> extends EventDispatcher<Events> {
-    children: Component[];
-    private unloaders;
-    loaded: boolean;
-    protected _containerEl: HTMLElement;
-    get containerEl(): HTMLElement;
-    set containerEl(el: HTMLElement);
-    /**
-     * Load this component and its children
-     *
-     * @public
-     */
-    load(): void;
-    /**
-     * Override this to load your component
-     *
-     * @abstract
-     * @public
-     */
-    onload(): Promise<void> | void;
-    protected loadAsync(): Promise<void>;
-    /**
-     * Unload this component and its children
-     *
-     * @public
-     */
-    unload(): void;
-    protected unloadAsync(): Promise<void>;
-    /**
-     * Override this to unload your component
-     *
-     * @abstract
-     * @public
-     */
-    onunload(): void;
-    private cleanupAsync;
-    /**
-     * Adds a child component, loading it if this component is loaded
-     *
-     * @public
-     */
-    addChild<T extends Component>(component: T): T;
-    /**
-     * Removes a child component, unloading it
-     *
-     * @public
-     */
-    removeChild<T extends Component>(component: T): T;
-    /**
-     * Registers a callback to be called when unloading
-     *
-     * @public
-     */
-    register(cb: () => any): void;
-    registerEvent<T extends ValidEventTypes, K extends EventNames<T>>(eventRef: EventRef<T, K, any>): void;
-    registerInterval(id: ReturnType<typeof setInterval>): void;
-    /**
-     * Registers an DOM event to be detached when unloading
-     *
-     * @public
-     */
-    registerDomEvent<K extends keyof HTMLElementEventMap>(el: HTMLElement, type: K, callback: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
-    registerDomEvent<K extends keyof DocumentEventMap>(el: Document, type: K, callback: (this: HTMLElement, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
-    registerDomEvent<K extends keyof WindowEventMap>(el: Window, type: K, callback: (this: HTMLElement, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+export declare abstract class Component<
+  Events extends ValidEventTypes = Record<string, any>,
+> extends EventDispatcher<Events> {
+  children: Component[];
+  private unloaders;
+  loaded: boolean;
+  protected _containerEl: HTMLElement;
+  get containerEl(): HTMLElement;
+  set containerEl(el: HTMLElement);
+  /**
+   * Load this component and its children
+   *
+   * @public
+   */
+  load(): void;
+  /**
+   * Override this to load your component
+   *
+   * @abstract
+   * @public
+   */
+  onload(): Promise<void> | void;
+  protected loadAsync(): Promise<void>;
+  /**
+   * Unload this component and its children
+   *
+   * @public
+   */
+  unload(): void;
+  protected unloadAsync(): Promise<void>;
+  /**
+   * Override this to unload your component
+   *
+   * @abstract
+   * @public
+   */
+  onunload(): void;
+  private cleanupAsync;
+  /**
+   * Adds a child component, loading it if this component is loaded
+   *
+   * @public
+   */
+  addChild<T extends Component>(component: T): T;
+  /**
+   * Removes a child component, unloading it
+   *
+   * @public
+   */
+  removeChild<T extends Component>(component: T): T;
+  /**
+   * Registers a callback to be called when unloading
+   *
+   * @public
+   */
+  register(cb: () => any): void;
+  registerEvent<T extends ValidEventTypes, K extends EventNames<T>>(
+    eventRef: EventRef<T, K, any>,
+  ): void;
+  registerInterval(id: ReturnType<typeof setInterval>): void;
+  /**
+   * Registers an DOM event to be detached when unloading
+   *
+   * @public
+   */
+  registerDomEvent<K extends keyof HTMLElementEventMap>(
+    el: HTMLElement,
+    type: K,
+    callback: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any,
+    options?: boolean | AddEventListenerOptions,
+  ): void;
+  registerDomEvent<K extends keyof DocumentEventMap>(
+    el: Document,
+    type: K,
+    callback: (this: HTMLElement, ev: DocumentEventMap[K]) => any,
+    options?: boolean | AddEventListenerOptions,
+  ): void;
+  registerDomEvent<K extends keyof WindowEventMap>(
+    el: Window,
+    type: K,
+    callback: (this: HTMLElement, ev: WindowEventMap[K]) => any,
+    options?: boolean | AddEventListenerOptions,
+  ): void;
 }
 /**
  * Additional metadata returned from view-state transitions.
@@ -85,13 +109,13 @@ export declare abstract class Component<Events extends ValidEventTypes = Record<
  * @public
  */
 export interface ViewStateResult {
-    /**
-     * Set this to true to indicate that there is a state change which should be
-     * recorded in the navigation history.
-     *
-     * @public
-     */
-    history: boolean;
+  /**
+   * Set this to true to indicate that there is a state change which should be
+   * recorded in the navigation history.
+   *
+   * @public
+   */
+  history: boolean;
 }
 /**
  * Serialized workspace state for a single leaf.
@@ -99,27 +123,27 @@ export interface ViewStateResult {
  * @public
  */
 export interface ViewState {
-    /** @public */
-    type: string;
-    /** @public */
-    state?: Record<string, unknown>;
-    /** @public */
-    active?: boolean;
-    /** @public */
-    pinned?: boolean;
-    /** @public */
-    group?: WorkspaceLeaf;
+  /** @public */
+  type: string;
+  /** @public */
+  state?: Record<string, unknown>;
+  /** @public */
+  active?: boolean;
+  /** @public */
+  pinned?: boolean;
+  /** @public */
+  group?: WorkspaceLeaf;
 }
 /**
- * Header breadcrumb contributed by a view. Keep the leaf filename in the
- * header title rather than this list.
+ * Header breadcrumb contributed by a view. Keep the leaf filename in the header
+ * title rather than this list.
  *
  * @public
  */
 export interface ViewBreadcrumb {
-    id: string;
-    label: string;
-    onSelect?: () => void;
+  id: string;
+  label: string;
+  onSelect?: () => void;
 }
 /**
  * Base class for anything that can be mounted inside a workspace leaf.
@@ -127,37 +151,41 @@ export interface ViewBreadcrumb {
  * @public
  */
 export declare abstract class View extends Component {
-    icon: string;
-    leaf: WorkspaceLeaf;
-    scope: Scope | null;
-    protected state: Record<string, unknown>;
-    constructor(leaf?: WorkspaceLeaf);
-    get containerEl(): HTMLElement;
-    get app(): App;
-    /** @public */
-    protected abstract onOpen(): Promise<void>;
-    /** @public */
-    protected abstract onClose(): Promise<void>;
-    /** @public */
-    abstract getViewType(): string;
-    getState(): Record<string, unknown>;
-    setState(state: Record<string, unknown>, result?: ViewStateResult): Promise<void>;
-    getIcon(): string;
-    abstract getDisplayText(): string;
-    getBreadcrumbFilePath(): string | null;
-    getBreadcrumbs(): ViewBreadcrumb[];
-    onPaneMenu(menu: Menu, source: "more-options" | "tab-header" | string): void;
+  icon: string;
+  leaf: WorkspaceLeaf;
+  scope: Scope | null;
+  protected state: Record<string, unknown>;
+  constructor(leaf?: WorkspaceLeaf);
+  get containerEl(): HTMLElement;
+  get app(): App;
+  /** @public */
+  protected abstract onOpen(): Promise<void>;
+  /** @public */
+  protected abstract onClose(): Promise<void>;
+  /** @public */
+  abstract getViewType(): string;
+  getState(): Record<string, unknown>;
+  setState(
+    state: Record<string, unknown>,
+    result?: ViewStateResult,
+  ): Promise<void>;
+  getIcon(): string;
+  abstract getDisplayText(): string;
+  getClosePersistenceScope(): "application" | "layout";
+  getBreadcrumbFilePath(): string | null;
+  getBreadcrumbs(): ViewBreadcrumb[];
+  onPaneMenu(menu: Menu, source: "more-options" | "tab-header" | string): void;
 }
 export declare class EmptyView extends View {
-    private component;
-    constructor(leaf?: WorkspaceLeaf);
-    protected onOpen(): Promise<void>;
-    protected onClose(): Promise<void>;
-    load(): void;
-    unload(): void;
-    getViewType(): string;
-    getDisplayText(): string;
-    getIcon(): string;
+  private component;
+  constructor(leaf?: WorkspaceLeaf);
+  protected onOpen(): Promise<void>;
+  protected onClose(): Promise<void>;
+  load(): void;
+  unload(): void;
+  getViewType(): string;
+  getDisplayText(): string;
+  getIcon(): string;
 }
 /**
  * View base class with an action bar and content area.
@@ -165,20 +193,25 @@ export declare class EmptyView extends View {
  * @public
  */
 export declare abstract class ItemView extends View {
-    actions: Array<{
-        icon: string;
-        title: string;
-        callback: (evt: MouseEvent) => any;
-        disabled?: boolean;
-    }>;
-    constructor(leaf?: WorkspaceLeaf);
-    get contentEl(): HTMLElement;
-    unload(): void;
-    addAction(icon: string, title: string, callback: (evt: MouseEvent) => any, options?: {
-        disabled?: boolean;
-    }): void;
-    protected onOpen(): Promise<void>;
-    protected onClose(): Promise<void>;
+  actions: Array<{
+    icon: string;
+    title: string;
+    callback: (evt: MouseEvent) => any;
+    disabled?: boolean;
+  }>;
+  constructor(leaf?: WorkspaceLeaf);
+  get contentEl(): HTMLElement;
+  unload(): void;
+  addAction(
+    icon: string,
+    title: string,
+    callback: (evt: MouseEvent) => any,
+    options?: {
+      disabled?: boolean;
+    },
+  ): void;
+  protected onOpen(): Promise<void>;
+  protected onClose(): Promise<void>;
 }
 /**
  * Item view base class that is backed by a vault file.
@@ -186,13 +219,13 @@ export declare abstract class ItemView extends View {
  * @public
  */
 export declare abstract class FileView extends ItemView {
-    file: TFile | null;
-    constructor(leaf?: WorkspaceLeaf);
-    getBreadcrumbFilePath(): string | null;
-    abstract onLoadFile(file: TFile): Promise<void>;
-    abstract onUnloadFile(file: TFile): Promise<void>;
-    abstract onRename(file: TFile): Promise<void>;
-    abstract canAcceptExtension(extension: string): boolean;
+  file: TFile | null;
+  constructor(leaf?: WorkspaceLeaf);
+  getBreadcrumbFilePath(): string | null;
+  abstract onLoadFile(file: TFile): Promise<void>;
+  abstract onUnloadFile(file: TFile): Promise<void>;
+  abstract onRename(file: TFile): Promise<void>;
+  abstract canAcceptExtension(extension: string): boolean;
 }
 /**
  * File view base class for text-backed editors.
@@ -200,16 +233,16 @@ export declare abstract class FileView extends ItemView {
  * @public
  */
 export declare abstract class TextFileView extends FileView {
-    editor: Editor;
-    data: string;
-    constructor(leaf?: WorkspaceLeaf);
-    get adapter(): DataAdapter;
-    abstract getViewData(): string;
-    abstract setViewData(data: string, clear?: boolean): void;
-    abstract clear(): void;
-    onLoadFile(file: TFile): Promise<void>;
-    getIcon(): string;
-    onRename(file: TFile): Promise<void>;
-    onUnloadFile(file: TFile): Promise<void>;
-    save(clear?: boolean): Promise<void>;
+  editor: Editor;
+  data: string;
+  constructor(leaf?: WorkspaceLeaf);
+  get adapter(): DataAdapter;
+  abstract getViewData(): string;
+  abstract setViewData(data: string, clear?: boolean): void;
+  abstract clear(): void;
+  onLoadFile(file: TFile): Promise<void>;
+  getIcon(): string;
+  onRename(file: TFile): Promise<void>;
+  onUnloadFile(file: TFile): Promise<void>;
+  save(clear?: boolean): Promise<void>;
 }

package/dist/view.svelte.js

@@ -1,5 +1,4 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { DateTime } from "luxon";
 import { Editor } from "./editor.svelte";
 import { mount, unmount } from "svelte";
 import EmptyViewComponent from "./components/empty-view/empty-view.svelte";
@@ -209,8 +208,17 @@ export class View extends Component {
         return this.icon;
     }
     /**
-     * Vault path used for parent-path header breadcrumbs. File views return
-     * the open file; other views MAY return a related path or null.
+     * Layout-only views own no file writers and retain staged state outside their
+     * UI. Every other view keeps the complete application writer close guard.
+     *
+     * @public
+     */
+    getClosePersistenceScope() {
+        return "application";
+    }
+    /**
+     * Vault path used for parent-path header breadcrumbs. File views return the
+     * open file; other views MAY return a related path or null.
      *
      * @public
      */
@@ -330,22 +338,34 @@ export class TextFileView extends FileView {
         return this.app.vault.adapter;
     }
     async onLoadFile(file) {
-        return this.app.telemetry.measureAsync("view.text_file.on_load_file", async (span) => {
+        const application = this.app;
+        return application.telemetry.measureAsync("view.text_file.on_load_file", async (span) => {
             span.setAttribute("view.type", this.getViewType());
             span.setAttribute("file.extension", file.extension);
-            const contents = await this.app.telemetry.measureAsync("vault.read", async () => this.app.vault.read(file), {
+            const published = await this.editor.loadDocument(file, () => application.telemetry.measureAsync("vault.read", async () => application.vault.read(file), {
                 attributes: {
                     "file.extension": file.extension,
                     "view.type": this.getViewType(),
                 },
                 slowThresholdMs: 100,
+            }), (contents) => {
+                if (this.app !== application || this.editor.app !== application)
+                    throw new Error("Editor document load authority changed");
+                const previousFile = this.file, previousData = this.data;
+                try {
+                    this.file = file.copy();
+                    this.editor.extensions = application.editorExtensions(file.extension, { ...this.getState(), file: file.path });
+                    this.data = contents;
+                    this.setViewData(contents, true);
+                }
+                catch (error) {
+                    this.file = previousFile;
+                    this.data = previousData;
+                    throw error;
+                }
             });
-            this.file = file.copy();
-            this.editor.file = file;
-            await this.setState({ ...this.getState(), file: file.path });
-            this.editor.extensions = this.app.editorExtensions(this.file.extension, this.getState());
-            this.data = contents;
-            this.setViewData(contents, true);
+            if (published && this.editor.file === file)
+                await this.setState({ ...this.getState(), file: file.path });
         }, {
             attributes: {
                 "view.type": this.getViewType(),
@@ -364,18 +384,16 @@ export class TextFileView extends FileView {
         return Promise.resolve();
     }
     onUnloadFile(file) {
+        this.editor.cancelDocumentLoad();
         this.setState({ ...this.getState(), file: "" });
         return Promise.resolve();
     }
-    save(clear) {
-        return this.app.vault
-            .modify(this.file, this.data, {
-            mtime: DateTime.now().toMillis(),
-        })
-            .then(() => {
-            if (clear) {
-                this.clear();
-            }
-        });
+    async save(clear) {
+        const target = this.editor.file;
+        this.editor.save();
+        await this.editor.flushChanges();
+        this.data = this.editor.data;
+        if (clear && this.editor.file === target)
+            this.clear();
     }
 }

package/dist/workspace-close-guard.d.ts

@@ -0,0 +1,3 @@
+import type { Workspace } from "./workspace.svelte";
+/** Keep the App's persistence barrier held through destructive shell changes. */
+export declare function workspaceCloseGuard(workspace: Workspace, hostDocuments?: () => Document[]): (ids: string[], remove: () => void) => Promise<void>;

package/dist/workspace-close-guard.js

@@ -0,0 +1,35 @@
+import { tick } from "svelte";
+/** Keep the App's persistence barrier held through destructive shell changes. */
+export function workspaceCloseGuard(workspace, hostDocuments = () => []) {
+    return async (ids, remove) => {
+        const targets = ids.map((id) => {
+            const leaf = workspace.getLeafById(id);
+            const view = leaf?.view;
+            return { id, leaf, view, scope: view?.getClosePersistenceScope?.() };
+        });
+        const documents = new Set(ids.map((id) => workspace.getCommandHostDocument(workspace.getCommandHostIdForLeaf(workspace.getLeafById(id)))));
+        for (const doc of hostDocuments())
+            documents.add(doc);
+        for (const doc of documents) {
+            const active = doc?.activeElement;
+            active?.blur?.();
+        }
+        await tick();
+        const registry = workspace.app.fileEditingSessions;
+        await registry.settleOperations();
+        await workspace.flushLayout();
+        const layoutOnly = targets.length > 0 &&
+            targets.every(({ id, leaf, view, scope }) => scope === "layout" &&
+                leaf &&
+                workspace.getLeafById(id) === leaf &&
+                leaf.view === view &&
+                view?.getClosePersistenceScope?.() === "layout");
+        if (layoutOnly) {
+            remove();
+            return;
+        }
+        await registry.guard(undefined, async () => {
+            remove();
+        });
+    };
+}

package/dist/workspace-host-internal.js

@@ -1,7 +1,15 @@
+const HOST_BINDING = Symbol.for("lapis.workspaceHostBinding");
 const workspaceHostBindings = new WeakMap();
 export function setWorkspaceHostBinding(workspace, binding) {
-    workspaceHostBindings.set(workspace, Object.freeze(binding));
+    const frozen = Object.freeze(binding);
+    workspaceHostBindings.set(workspace, frozen);
+    Object.defineProperty(workspace, HOST_BINDING, {
+        configurable: true,
+        enumerable: false,
+        value: frozen,
+    });
 }
 export function resolveWorkspaceHostBinding(workspace) {
-    return workspaceHostBindings.get(workspace);
+    return (workspaceHostBindings.get(workspace) ??
+        workspace[HOST_BINDING]);
 }

package/dist/workspace-layout-normalizer.d.ts

@@ -62,7 +62,7 @@ type WorkspaceBottomPanelJson = WorkspaceTabsJson & {
 type WorkspaceWindowJson = {
     id: string;
     type: "floating";
-    mode?: "floating";
+    mode?: "floating" | "popout";
     displayState?: "collapsed" | "minimized";
     direction: "horizontal" | "vertical";
     sizes: number[];
@@ -88,5 +88,7 @@ export type WorkspaceJson = {
  * Always returns a structurally valid {@link WorkspaceJson} even when the input
  * is `null`, empty, partial, or corrupted.
  */
-export declare function normalizeWorkspaceJson(raw: unknown): WorkspaceJson;
+export declare function normalizeWorkspaceJson(raw: unknown, options?: {
+    preservePopouts?: boolean;
+}): WorkspaceJson;
 export {};

package/dist/workspace-layout-normalizer.js

@@ -226,14 +226,14 @@ function normalizeBottomPanel(raw) {
             : "0px",
     };
 }
-function normalizeFloatingWindow(raw) {
+function normalizeFloatingWindow(raw, preservePopouts = false) {
     if (!raw || typeof raw !== "object")
         return null;
     const r = raw;
     if (r.type !== "floating")
         return null;
     // Popout windows cannot be restored across sessions — drop them.
-    if (r.mode === "popout")
+    if (r.mode === "popout" && !preservePopouts)
         return null;
     const children = (Array.isArray(r.children) ? r.children : [])
         .map(normalizeSplitChild)
@@ -249,7 +249,7 @@ function normalizeFloatingWindow(raw) {
     return {
         id: ensureId(r.id),
         type: "floating",
-        mode: "floating",
+        mode: r.mode === "popout" ? "popout" : "floating",
         ...(displayState !== undefined ? { displayState } : {}),
         direction: ensureDirection(r.direction),
         sizes: repairSizes(r.sizes, children.length),
@@ -283,11 +283,11 @@ function hasAnyLeaf(nodes) {
  * Always returns a structurally valid {@link WorkspaceJson} even when the input
  * is `null`, empty, partial, or corrupted.
  */
-export function normalizeWorkspaceJson(raw) {
+export function normalizeWorkspaceJson(raw, options = {}) {
     const r = raw && typeof raw === "object" ? raw : {};
     const floating = Array.isArray(r.floating)
         ? r.floating
-            .map(normalizeFloatingWindow)
+            .map((window) => normalizeFloatingWindow(window, options.preservePopouts))
             .filter((w) => w !== null)
         : [];
     return {

package/dist/workspace-view-document.d.ts

@@ -0,0 +1,3 @@
+import type { WorkspaceLeaf } from "./workspace.svelte";
+/** Retarget a retained editor's DOM services when its view changes document. */
+export declare function attachWorkspaceView(target: HTMLElement, leaf: WorkspaceLeaf): void;

package/dist/workspace-view-document.js

@@ -0,0 +1,12 @@
+/** Retarget a retained editor's DOM services when its view changes document. */
+export function attachWorkspaceView(target, leaf) {
+    target.replaceChildren(leaf.containerEl);
+    const editor = leaf.view.editor;
+    const node = target.getRootNode();
+    const root = node.nodeType === 9 || node.nodeType === 11
+        ? node
+        : target.ownerDocument;
+    if (editor?.view && editor.view.root !== root) {
+        editor.view.setRoot(root);
+    }
+}