@lvce-editor/api 9.28.3 → 9.29.1

package/dist/index.d.ts

@@ -27,10 +27,11 @@ export { getLanguageServerRegistrySnapshot, registerLanguageServer, resetLanguag
 export { registerBraceCompletionProvider, registerClosingTagProvider, registerCodeActionsProvider, registerCommentProvider, registerDefinitionProvider, registerDocumentSymbolProvider, registerImplementationProvider, registerReferenceProvider, registerRenameProvider, registerSelectionProvider, registerTabCompletionProvider, registerTypeDefinitionProvider, resetLanguageProviderRegistry, } from './parts/LanguageProvider/LanguageProvider.ts';
 export type { DocumentSymbol, DocumentSymbolProvider, DocumentSymbolTextDocument, LanguageProvider, } from './parts/LanguageProvider/LanguageProvider.ts';
 export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileBeforeUri, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlIsActive, registerSourceControlProvider, resetSourceControlProviderRegistry, } from './parts/SourceControl/SourceControl.ts';
-export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, setViewInstanceActive, } from './parts/ViewRegistry/ViewRegistry.ts';
+export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewInstanceState, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, setViewInstanceState, setViewInstanceActive, } from './parts/ViewRegistry/ViewRegistry.ts';
+export * as ViewletStates from './parts/PublicViewletStates/PublicViewletStates.ts';
 export { createOutputChannel, getOutputChannelLogs, getOutputChannelRegistrySnapshot, resetOutputChannelRegistry, } from './parts/OutputChannel/OutputChannel.ts';
 export { getStatusBarItemProviderRegistrySnapshot, registerStatusBarItemProvider, resetStatusBarItemProviderRegistry, } from './parts/StatusBar/StatusBar.ts';
-export type { RegisteredView, View, ViewAction, ViewCommand, ViewContext, ViewEvent, ViewKind, ViewPreferredLocation, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, ViewScrollPosition, ViewSelection, VirtualDomViewInstance, } from './parts/View/View.ts';
+export type { RegisteredView, InstanceView, StatefulView, View, ViewAction, ViewCommand, ViewContext, ViewEvent, ViewKind, ViewPreferredLocation, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, ViewScrollPosition, ViewSelection, VirtualDomViewInstance, } from './parts/View/View.ts';
 export { handleExtensionManagementMessagePort } from './parts/HandleExtensionManagementMessagePort/HandleExtensionManagementMessagePort.ts';
 export { createNodeRpc, createRpc } from './parts/Rpc/Rpc.ts';
 export type { Command } from './parts/Command/Command.ts';

package/dist/index.js

@@ -26,7 +26,8 @@ export { openDebugConsole, openOutputView, openProblemsView, } from "./parts/Pan
 export { getLanguageServerRegistrySnapshot, registerLanguageServer, resetLanguageServerRegistry } from "./parts/LanguageServer/LanguageServer.js";
 export { registerBraceCompletionProvider, registerClosingTagProvider, registerCodeActionsProvider, registerCommentProvider, registerDefinitionProvider, registerDocumentSymbolProvider, registerImplementationProvider, registerReferenceProvider, registerRenameProvider, registerSelectionProvider, registerTabCompletionProvider, registerTypeDefinitionProvider, resetLanguageProviderRegistry, } from "./parts/LanguageProvider/LanguageProvider.js";
 export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileBeforeUri, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlIsActive, registerSourceControlProvider, resetSourceControlProviderRegistry, } from "./parts/SourceControl/SourceControl.js";
-export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, setViewInstanceActive, } from "./parts/ViewRegistry/ViewRegistry.js";
+export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewInstanceState, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, setViewInstanceState, setViewInstanceActive, } from "./parts/ViewRegistry/ViewRegistry.js";
+export * as ViewletStates from "./parts/PublicViewletStates/PublicViewletStates.js";
 export { createOutputChannel, getOutputChannelLogs, getOutputChannelRegistrySnapshot, resetOutputChannelRegistry, } from "./parts/OutputChannel/OutputChannel.js";
 export { getStatusBarItemProviderRegistrySnapshot, registerStatusBarItemProvider, resetStatusBarItemProviderRegistry, } from "./parts/StatusBar/StatusBar.js";
 export { handleExtensionManagementMessagePort } from "./parts/HandleExtensionManagementMessagePort/HandleExtensionManagementMessagePort.js";

package/dist/parts/FileSystem/FileSystem.js

@@ -46,7 +46,7 @@ export const getFileHashes = async (uris) => {
     return FileSystemWorker.invoke('FileSystem.getFileHashes', uris);
 };
 export const readFile = async (uri) => {
-    if (isMemory(uri)) {
+    if (isCustomFileSystemUri(uri)) {
         return ExtensionManagementWorker.invoke('ExtensionApi.readFile', uri);
     }
     return FileSystemWorker.readFile(uri);

package/dist/parts/PublicViewletStates/PublicViewletStates.d.ts

@@ -0,0 +1 @@
+export { get, set } from '../ViewletStates/ViewletStates.ts';

package/dist/parts/PublicViewletStates/PublicViewletStates.js

@@ -0,0 +1 @@
+export { get, set } from "../ViewletStates/ViewletStates.js";

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

@@ -62,9 +62,8 @@ export interface VirtualDomViewInstance {
     readonly saveState?: () => unknown;
 }
 export type ViewCommand<State = VirtualDomViewInstance, Args extends readonly any[] = readonly any[]> = (state: State, ...args: Args) => State | Promise<State>;
-export interface View<State = unknown> {
+interface ViewBase<State> {
     readonly commands?: Readonly<Record<string, ViewCommand<State>>>;
-    readonly create: (context?: ViewContext) => State | Promise<State>;
     readonly displayName?: string;
     readonly eventListeners?: readonly DomEventListener[];
     readonly icon?: string;
@@ -74,6 +73,29 @@ export interface View<State = unknown> {
     readonly preferredLocation?: ViewPreferredLocation;
     readonly title?: string;
 }
+export interface InstanceView<State = unknown> extends ViewBase<State> {
+    readonly create: (context?: ViewContext) => State | Promise<State>;
+    readonly createInitialState?: never;
+}
+export interface StatefulView<State = unknown> extends ViewBase<State> {
+    readonly create?: never;
+    readonly createInitialState: (context?: ViewContext) => State | Promise<State>;
+    readonly dispose?: (state: State) => unknown;
+    readonly getContext?: (state: State) => Readonly<Record<string, boolean>>;
+    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 render: (state: State) => readonly VirtualDomNode[] | Promise<readonly VirtualDomNode[]>;
+    readonly renderActions?: (state: State) => readonly ViewAction[] | Promise<readonly ViewAction[]>;
+    readonly renderActionsDom?: (state: State) => readonly VirtualDomNode[];
+    readonly renderFocus?: (state: State, oldContext: Readonly<Record<string, boolean>>, newContext: Readonly<Record<string, boolean>>) => string | Promise<string>;
+    readonly renderScrollPosition?: (state: State) => readonly [] | ViewScrollPosition | Promise<readonly [] | ViewScrollPosition>;
+    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 saveState?: (state: State) => unknown;
+}
+export type View<State = unknown> = InstanceView<State> | StatefulView<State>;
 export interface RegisteredView {
     readonly displayName?: string;
     readonly eventListeners?: readonly DomEventListener[];
@@ -82,6 +104,7 @@ export interface RegisteredView {
     readonly kind?: ViewKind;
     readonly name?: string;
     readonly preferredLocation: ViewPreferredLocation;
+    readonly stateful?: boolean;
     readonly title?: string;
 }
 export interface ViewRegistrySnapshot {
@@ -106,3 +129,4 @@ export interface ViewRenderResultPatches {
     readonly type: 'setPatches';
 }
 export type ViewRenderResult = ViewRenderResultDom | ViewRenderResultPatches;
+export {};

package/dist/parts/ViewRegistry/ViewRegistry.d.ts

@@ -9,6 +9,8 @@ export declare const renderViewInstance: (uid: number) => Promise<ViewRenderResu
 export declare const setViewInstanceActive: (uid: number, active: boolean) => Promise<void>;
 export declare const disposeViewInstance: (uid: number) => Promise<void>;
 export declare const saveViewInstanceState: (uid: number) => Promise<unknown>;
+export declare const getViewInstanceState: (uid: number) => unknown;
+export declare const setViewInstanceState: (uid: number, newState: unknown) => Promise<ViewRenderResult>;
 export declare const getViewMenuEntries: (uid: number, menuId: string) => Promise<readonly MenuEntry[]>;
 export declare const getViewActions: (uid: number) => Promise<readonly ViewAction[]>;
 export declare const getViewActionsDom: (uid: number) => readonly VirtualDomNode[] | undefined;

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -3,6 +3,7 @@ import { diffTree, validate as validateVirtualDom } from '@lvce-editor/virtual-d
 import { registerCommand } from "../CommandRegistry/CommandRegistry.js";
 import * as ExtensionApiCommandRegistry from "../ExtensionApiCommandRegistry/ExtensionApiCommandRegistry.js";
 import { ExtensionApiError } from "../ExtensionApiError/ExtensionApiError.js";
+import * as ViewletStates from "../ViewletStates/ViewletStates.js";
 import * as ViewStatusBarItems from "../ViewStatusBarItems/ViewStatusBarItems.js";
 const views = Object.create(null);
 const instances = Object.create(null);
@@ -11,6 +12,7 @@ const renderedDoms = Object.create(null);
 const contexts = Object.create(null);
 const contextViewIds = Object.create(null);
 const viewCommandDisposables = Object.create(null);
+const isStatefulView = (view) => typeof view.createInitialState === 'function';
 const assertBoolean = (value, message) => {
     if (value !== undefined && typeof value !== 'boolean') {
         throw new ExtensionApiError(message);
@@ -82,9 +84,13 @@ const assertView = (view) => {
     if (typeof view.id !== 'string' || view.id.length === 0) {
         throw new ExtensionApiError('view is missing id');
     }
-    if (typeof view.create !== 'function') {
+    const candidate = view;
+    if (typeof candidate.create !== 'function' && typeof candidate.createInitialState !== 'function') {
         throw new ExtensionApiError(`view ${view.id} is missing create function`);
     }
+    if (typeof candidate.createInitialState === 'function' && typeof candidate.render !== 'function') {
+        throw new ExtensionApiError(`view ${view.id} is missing render function`);
+    }
     if (view.id in views) {
         throw new ExtensionApiError(`view ${view.id} is already registered`);
     }
@@ -103,6 +109,7 @@ const toRegisteredView = (view) => {
         id: view.id,
         name: view.name,
         preferredLocation: view.preferredLocation || 'sideBar',
+        ...(isStatefulView(view) && { stateful: true }),
         title: displayName,
     };
     if (view.kind) {
@@ -131,9 +138,16 @@ const executeViewCommand = async (view, commandId, args) => {
     }
     const [uid, instance] = activeInstance;
     const command = view.commands[commandId];
-    const newInstance = await command(instance, ...args);
-    assertVirtualDomViewInstance(view.id, newInstance);
-    instances[uid] = newInstance;
+    if (isStatefulView(view)) {
+        const newState = await command(ViewletStates.get(uid), ...args);
+        assertViewState(view.id, newState);
+        ViewletStates.replace(uid, newState);
+    }
+    else {
+        const newInstance = await command(instance, ...args);
+        assertVirtualDomViewInstance(view.id, newInstance);
+        instances[uid] = newInstance;
+    }
     await ExtensionManagementWorker.invoke('Extensions.requestViewRerender', uid);
 };
 const registerViewCommands = (view) => {
@@ -177,7 +191,7 @@ export const executeViewProvider = (id) => {
     if (!view) {
         throw new ExtensionApiError(`view ${id} not found`);
     }
-    return view.create();
+    return isStatefulView(view) ? view.createInitialState() : view.create();
 };
 const assertVirtualDomViewInstance = (id, instance) => {
     if (!instance || typeof instance !== 'object') {
@@ -187,6 +201,62 @@ const assertVirtualDomViewInstance = (id, instance) => {
         throw new ExtensionApiError(`view ${id} instance is missing render function`);
     }
 };
+const assertViewState = (viewId, state) => {
+    if (!state || typeof state !== 'object' || Array.isArray(state)) {
+        throw new ExtensionApiError(`view ${viewId} state must be an object`);
+    }
+};
+const createStatefulViewInstance = (view, uid) => {
+    const instance = {
+        render() {
+            return view.render(ViewletStates.get(uid));
+        },
+    };
+    if (view.dispose) {
+        instance.dispose = () => view.dispose(ViewletStates.get(uid));
+    }
+    if (view.getContext) {
+        instance.getContext = () => view.getContext(ViewletStates.get(uid));
+    }
+    if (view.getCss) {
+        instance.getCss = () => view.getCss(ViewletStates.get(uid));
+    }
+    if (view.getMenuEntries) {
+        instance.getMenuEntries = (menuId) => view.getMenuEntries(ViewletStates.get(uid), menuId);
+    }
+    if (view.handleEvent) {
+        instance.handleEvent = async (event) => {
+            const newState = await view.handleEvent(ViewletStates.get(uid), event);
+            assertViewState(view.id, newState);
+            ViewletStates.replace(uid, newState);
+        };
+    }
+    if (view.renderActions) {
+        instance.renderActions = () => view.renderActions(ViewletStates.get(uid));
+    }
+    if (view.renderActionsDom) {
+        instance.renderActionsDom = () => view.renderActionsDom(ViewletStates.get(uid));
+    }
+    if (view.renderFocus) {
+        instance.renderFocus = (oldContext, newContext) => view.renderFocus(ViewletStates.get(uid), oldContext, newContext);
+    }
+    if (view.renderScrollPosition) {
+        instance.renderScrollPosition = () => view.renderScrollPosition(ViewletStates.get(uid));
+    }
+    if (view.renderSelections) {
+        instance.renderSelections = () => view.renderSelections(ViewletStates.get(uid));
+    }
+    if (view.renderStatusBarItems) {
+        instance.renderStatusBarItems = () => view.renderStatusBarItems(ViewletStates.get(uid));
+    }
+    if (view.renderTitle) {
+        instance.renderTitle = () => view.renderTitle(ViewletStates.get(uid));
+    }
+    if (view.saveState) {
+        instance.saveState = () => view.saveState(ViewletStates.get(uid));
+    }
+    return instance;
+};
 const getVirtualDomInstance = (uid) => {
     const instance = instances[uid];
     if (!instance) {
@@ -448,7 +518,7 @@ export const createViewInstance = async (viewId, uid, context) => {
     if (view.kind !== 'virtualDom') {
         throw new ExtensionApiError(`view ${viewId} is not a virtual dom view`);
     }
-    const instance = await view.create({
+    const viewContext = {
         ...context,
         requestRerender() {
             return ExtensionManagementWorker.invoke('Extensions.requestViewRerender', uid);
@@ -461,7 +531,19 @@ export const createViewInstance = async (viewId, uid, context) => {
         },
         uid,
         viewId,
-    });
+    };
+    let instance;
+    if (isStatefulView(view)) {
+        const initialState = await view.createInitialState(viewContext);
+        assertViewState(viewId, initialState);
+        ViewletStates.initialize(uid, initialState);
+        instance = createStatefulViewInstance(view, uid);
+    }
+    else {
+        const createdInstance = await view.create(viewContext);
+        assertVirtualDomViewInstance(viewId, createdInstance);
+        instance = createdInstance;
+    }
     assertVirtualDomViewInstance(viewId, instance);
     instances[uid] = instance;
     const instanceUids = instanceUidsByView[viewId] || new Set();
@@ -531,6 +613,7 @@ export const disposeViewInstance = async (uid) => {
             delete instances[uid];
             delete renderedDoms[uid];
             delete contextViewIds[uid];
+            ViewletStates.remove(uid);
         }
     }
 };
@@ -541,6 +624,24 @@ export const saveViewInstanceState = async (uid) => {
     }
     return instance.saveState();
 };
+export const getViewInstanceState = (uid) => {
+    getVirtualDomInstance(uid);
+    return ViewletStates.get(uid);
+};
+export const setViewInstanceState = async (uid, newState) => {
+    getVirtualDomInstance(uid);
+    const viewId = contextViewIds[uid];
+    assertViewState(viewId, newState);
+    const oldState = ViewletStates.get(uid);
+    ViewletStates.replace(uid, newState);
+    try {
+        return await renderViewInstance(uid);
+    }
+    catch (error) {
+        ViewletStates.replace(uid, oldState);
+        throw error;
+    }
+};
 export const getViewMenuEntries = async (uid, menuId) => {
     assertString(menuId, 'menuId must be a string');
     const instance = getVirtualDomInstance(uid);
@@ -579,14 +680,17 @@ const commandMap = {
     'ExtensionApi.executeViewProvider': executeViewProvider,
     'ExtensionApi.getViewActions': getViewActions,
     'ExtensionApi.getViewActionsDom': getViewActionsDom,
+    'ExtensionApi.getViewInstanceState': getViewInstanceState,
     'ExtensionApi.getViewMenuEntries': getViewMenuEntries,
     'ExtensionApi.getViewRegistrySnapshot': getViewRegistrySnapshot,
     'ExtensionApi.renderViewInstance': renderViewInstance,
     'ExtensionApi.saveViewInstanceState': saveViewInstanceState,
     'ExtensionApi.setViewInstanceActive': setViewInstanceActive,
+    'ExtensionApi.setViewInstanceState': setViewInstanceState,
 };
 export const resetViewRegistry = () => {
     ViewStatusBarItems.resetViewStatusBarItems();
+    ViewletStates.reset();
     for (const id of Object.keys(views)) {
         for (const disposable of viewCommandDisposables[id] || []) {
             disposable.dispose();

package/dist/parts/ViewletStates/ViewletStates.d.ts

@@ -0,0 +1,7 @@
+export declare const has: (uid: number) => boolean;
+export declare const get: <State = unknown>(uid: number) => State;
+export declare const replace: (uid: number, newState: unknown) => void;
+export declare const set: (uid: number, newState: unknown) => Promise<void>;
+export declare const initialize: (uid: number, initialState: unknown) => void;
+export declare const remove: (uid: number) => void;
+export declare const reset: () => void;

package/dist/parts/ViewletStates/ViewletStates.js

@@ -0,0 +1,38 @@
+import { ExtensionManagementWorker } from '@lvce-editor/rpc-registry';
+import { ExtensionApiError } from "../ExtensionApiError/ExtensionApiError.js";
+const states = Object.create(null);
+const assertState = (state) => {
+    if (!state || typeof state !== 'object' || Array.isArray(state)) {
+        throw new ExtensionApiError('view state must be an object');
+    }
+};
+export const has = (uid) => Object.hasOwn(states, uid);
+export const get = (uid) => {
+    if (!has(uid)) {
+        throw new ExtensionApiError(`view state ${uid} not found`);
+    }
+    return states[uid];
+};
+export const replace = (uid, newState) => {
+    if (!has(uid)) {
+        throw new ExtensionApiError(`view state ${uid} not found`);
+    }
+    assertState(newState);
+    states[uid] = newState;
+};
+export const set = async (uid, newState) => {
+    replace(uid, newState);
+    await ExtensionManagementWorker.invoke('Extensions.requestViewRerender', uid);
+};
+export const initialize = (uid, initialState) => {
+    assertState(initialState);
+    states[uid] = initialState;
+};
+export const remove = (uid) => {
+    delete states[uid];
+};
+export const reset = () => {
+    for (const uid of Object.keys(states)) {
+        delete states[Number(uid)];
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/api",
-  "version": "9.28.3",
+  "version": "9.29.1",
   "description": "Tree-shakeable extension API for Lvce Editor extensions.",
   "keywords": [
     "lvce-editor",
@@ -28,8 +28,8 @@
   "sideEffects": false,
   "dependencies": {
     "@lvce-editor/command": "^2.0.0",
-    "@lvce-editor/rpc": "^6.4.0",
-    "@lvce-editor/rpc-registry": "^9.24.0",
-    "@lvce-editor/virtual-dom-worker": "^11.2.0"
+    "@lvce-editor/rpc": "^6.16.0",
+    "@lvce-editor/rpc-registry": "^9.48.0",
+    "@lvce-editor/virtual-dom-worker": "^11.12.1"
   }
 }