@lvce-editor/api 9.38.0 → 9.39.0

package/dist/parts/View/View.d.ts

@@ -51,6 +51,8 @@ export interface VirtualDomViewInstance {
     readonly getCss?: () => string | Promise<string>;
     readonly getMenuEntries?: (menuId: string) => readonly MenuEntry[] | Promise<readonly MenuEntry[]>;
     readonly handleEvent?: (event: ViewEvent) => unknown;
+    /** Whether this document has edits that have not been saved. */
+    readonly isDirty?: () => boolean;
     readonly render: () => readonly VirtualDomNode[] | Promise<readonly VirtualDomNode[]>;
     readonly renderActions?: () => readonly ViewAction[] | Promise<readonly ViewAction[]>;
     readonly renderActionsDom?: () => readonly VirtualDomNode[];
@@ -59,6 +61,8 @@ export interface VirtualDomViewInstance {
     readonly renderSelections?: () => readonly ViewSelection[] | Promise<readonly ViewSelection[]>;
     readonly renderStatusBarItems?: () => readonly StatusBarItem[] | Promise<readonly StatusBarItem[]>;
     readonly renderTitle?: () => string | Promise<string>;
+    /** Persist committed edits. Reject on failure and retain dirty state until persistence succeeds. */
+    readonly save?: () => void | Promise<void>;
     readonly saveState?: () => unknown;
 }
 export type ViewCommand<State = VirtualDomViewInstance, Args extends readonly any[] = readonly any[]> = (state: State, ...args: Args) => State | Promise<State>;
@@ -87,6 +91,7 @@ export interface StatefulView<State = unknown> extends ViewBase<State> {
     readonly getCss?: (state: State) => string | Promise<string>;
     readonly getMenuEntries?: (state: State, menuId: string) => readonly MenuEntry[] | Promise<readonly MenuEntry[]>;
     readonly handleEvent?: (state: State, event: ViewEvent) => State | Promise<State>;
+    readonly isDirty?: (state: State) => boolean;
     readonly render: (state: State) => readonly VirtualDomNode[] | Promise<readonly VirtualDomNode[]>;
     readonly renderActions?: (state: State) => readonly ViewAction[] | Promise<readonly ViewAction[]>;
     readonly renderActionsDom?: (state: State) => readonly VirtualDomNode[];
@@ -95,6 +100,7 @@ export interface StatefulView<State = unknown> extends ViewBase<State> {
     readonly renderSelections?: (state: State) => readonly ViewSelection[] | Promise<readonly ViewSelection[]>;
     readonly renderStatusBarItems?: (state: State) => readonly StatusBarItem[] | Promise<readonly StatusBarItem[]>;
     readonly renderTitle?: (state: State) => string | Promise<string>;
+    readonly save?: (state: State) => State | Promise<State>;
     readonly saveState?: (state: State) => unknown;
 }
 export type View<State = unknown, ComponentState = unknown> = InstanceView<State, ComponentState> | StatefulView<State>;
@@ -116,6 +122,7 @@ export interface ViewRenderResultDom {
     readonly css?: string;
     readonly dom: readonly VirtualDomNode[];
     readonly focusSelector?: string;
+    readonly modified?: boolean;
     readonly scrollPosition?: ViewScrollPosition;
     readonly selections?: readonly ViewSelection[];
     readonly title?: string;
@@ -124,6 +131,7 @@ export interface ViewRenderResultDom {
 export interface ViewRenderResultPatches {
     readonly css?: string;
     readonly focusSelector?: string;
+    readonly modified?: boolean;
     readonly patches: readonly unknown[];
     readonly scrollPosition?: ViewScrollPosition;
     readonly selections?: readonly ViewSelection[];

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -236,6 +236,16 @@ const createStatefulViewInstance = (view, uid) => {
             ViewletStates.replace(uid, newState);
         };
     }
+    if (view.isDirty) {
+        instance.isDirty = () => view.isDirty(ViewletStates.get(uid));
+    }
+    if (view.save) {
+        instance.save = async () => {
+            const newState = await view.save(ViewletStates.get(uid));
+            assertViewState(view.id, newState);
+            ViewletStates.replace(uid, newState);
+        };
+    }
     if (view.renderActions) {
         instance.renderActions = () => view.renderActions(ViewletStates.get(uid));
     }
@@ -506,7 +516,14 @@ const withRenderMetadata = async (uid, viewId, result, instance, contextChange)
     const resultWithScrollPosition = await withScrollPosition(resultWithSelections, instance);
     const resultWithTitle = await withTitle(resultWithScrollPosition, instance);
     await ViewStatusBarItems.renderViewStatusBarItems(uid, viewId, instance);
-    return resultWithTitle;
+    if (typeof instance.isDirty !== 'function') {
+        return resultWithTitle;
+    }
+    const modified = instance.isDirty();
+    if (typeof modified !== 'boolean') {
+        throw new ExtensionApiError('view isDirty result must be a boolean');
+    }
+    return { ...resultWithTitle, modified };
 };
 const maybeClearContext = async (uid, viewId) => {
     if (!contexts[uid]) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/api",
-  "version": "9.38.0",
+  "version": "9.39.0",
   "description": "Tree-shakeable extension API for Lvce Editor extensions.",
   "keywords": [
     "lvce-editor",