@lvce-editor/api 8.35.0 → 8.37.0

package/dist/index.d.ts

@@ -12,7 +12,7 @@ export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSource
 export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, } from './parts/ViewRegistry/ViewRegistry.ts';
 export { createOutputChannel, getOutputChannelRegistrySnapshot, resetOutputChannelRegistry } from './parts/OutputChannel/OutputChannel.ts';
 export { getStatusBarItemProviderRegistrySnapshot, registerStatusBarItemProvider, resetStatusBarItemProviderRegistry, } from './parts/StatusBar/StatusBar.ts';
-export type { RegisteredView, View, ViewContext, ViewEvent, ViewKind, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, VirtualDomViewInstance, } from './parts/View/View.ts';
+export type { RegisteredView, View, ViewAction, ViewContext, ViewEvent, ViewKind, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, VirtualDomViewInstance, } from './parts/View/View.ts';
 export { handleExtensionManagementMessagePort } from './parts/HandleExtensionManagementMessagePort/HandleExtensionManagementMessagePort.ts';
 export type { Command } from './parts/Command/Command.ts';
 export type { CommandCallback } from './parts/CommandCallback/CommandCallback.ts';

package/dist/parts/CommandMap/CommandMap.d.ts

@@ -28,6 +28,7 @@ export declare const commandMap: {
     'ExtensionApi.getOutputChannelRegistrySnapshot': () => import("../OutputChannelRegistrySnapshot/OutputChannelRegistrySnapshot.ts").OutputChannelRegistrySnapshot;
     'ExtensionApi.getSourceControlProviderRegistrySnapshot': () => import("../SourceControlProviderRegistrySnapshot/SourceControlProviderRegistrySnapshot.ts").SourceControlProviderRegistrySnapshot;
     'ExtensionApi.getStatusBarItems': () => readonly import("../StatusBarItem/StatusBarItem.ts").StatusBarItem[];
+    'ExtensionApi.getViewActions': (uid: number) => Promise<readonly import("../View/View.ts").ViewAction[]>;
     'ExtensionApi.getViewMenuEntries': (uid: number, menuId: string) => Promise<readonly import("../View/View.ts").MenuEntry[]>;
     'ExtensionApi.getViewRegistrySnapshot': () => import("../View/View.ts").ViewRegistrySnapshot;
     'ExtensionApi.renderViewInstance': (uid: number) => Promise<import("../View/View.ts").ViewRenderResult>;

package/dist/parts/ExtensionApiCommandMap/ExtensionApiCommandMap.d.ts

@@ -27,6 +27,7 @@ export declare const commandMap: {
     'ExtensionApi.getOutputChannelRegistrySnapshot': () => import("../OutputChannelRegistrySnapshot/OutputChannelRegistrySnapshot.ts").OutputChannelRegistrySnapshot;
     'ExtensionApi.getSourceControlProviderRegistrySnapshot': () => import("../SourceControlProviderRegistrySnapshot/SourceControlProviderRegistrySnapshot.ts").SourceControlProviderRegistrySnapshot;
     'ExtensionApi.getStatusBarItems': () => readonly import("../StatusBarItem/StatusBarItem.ts").StatusBarItem[];
+    'ExtensionApi.getViewActions': (uid: number) => Promise<readonly import("../View/View.ts").ViewAction[]>;
     'ExtensionApi.getViewMenuEntries': (uid: number, menuId: string) => Promise<readonly import("../View/View.ts").MenuEntry[]>;
     'ExtensionApi.getViewRegistrySnapshot': () => import("../View/View.ts").ViewRegistrySnapshot;
     'ExtensionApi.renderViewInstance': (uid: number) => Promise<import("../View/View.ts").ViewRenderResult>;

package/dist/parts/ExtensionApiCommandMap/ExtensionApiCommandMap.js

@@ -6,7 +6,7 @@ import { getStatusBarItems } from "../GetStatusBarItems/GetStatusBarItems.js";
 import { executeHoverProvider, getHoverProviderRegistrySnapshot } from "../Hover/Hover.js";
 import { getOutputChannelRegistrySnapshot } from "../OutputChannel/OutputChannel.js";
 import { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetChangedFiles, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlIsActive, getSourceControlProviderRegistrySnapshot, } from "../SourceControl/SourceControl.js";
-import { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewMenuEntries, getViewRegistrySnapshot, renderViewInstance, saveViewInstanceState, } from "../ViewRegistry/ViewRegistry.js";
+import { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewActions, getViewMenuEntries, getViewRegistrySnapshot, renderViewInstance, saveViewInstanceState, } from "../ViewRegistry/ViewRegistry.js";
 export const commandMap = {
     'ExtensionApi.createViewInstance': createViewInstance,
     'ExtensionApi.dispatchViewEvent': dispatchViewEvent,
@@ -36,6 +36,7 @@ export const commandMap = {
     'ExtensionApi.getOutputChannelRegistrySnapshot': getOutputChannelRegistrySnapshot,
     'ExtensionApi.getSourceControlProviderRegistrySnapshot': getSourceControlProviderRegistrySnapshot,
     'ExtensionApi.getStatusBarItems': getStatusBarItems,
+    'ExtensionApi.getViewActions': getViewActions,
     'ExtensionApi.getViewMenuEntries': getViewMenuEntries,
     'ExtensionApi.getViewRegistrySnapshot': getViewRegistrySnapshot,
     'ExtensionApi.renderViewInstance': renderViewInstance,

package/dist/parts/ExtensionApiWorkerCommandMap/ExtensionApiWorkerCommandMap.d.ts

@@ -29,6 +29,7 @@ export declare const commandMap: {
     'ExtensionApi.getOutputChannelRegistrySnapshot': () => import("../OutputChannelRegistrySnapshot/OutputChannelRegistrySnapshot.ts").OutputChannelRegistrySnapshot;
     'ExtensionApi.getSourceControlProviderRegistrySnapshot': () => import("../SourceControlProviderRegistrySnapshot/SourceControlProviderRegistrySnapshot.ts").SourceControlProviderRegistrySnapshot;
     'ExtensionApi.getStatusBarItems': () => readonly import("../StatusBarItem/StatusBarItem.ts").StatusBarItem[];
+    'ExtensionApi.getViewActions': (uid: number) => Promise<readonly import("../View/View.ts").ViewAction[]>;
     'ExtensionApi.getViewMenuEntries': (uid: number, menuId: string) => Promise<readonly import("../View/View.ts").MenuEntry[]>;
     'ExtensionApi.getViewRegistrySnapshot': () => import("../View/View.ts").ViewRegistrySnapshot;
     'ExtensionApi.renderViewInstance': (uid: number) => Promise<import("../View/View.ts").ViewRenderResult>;

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

@@ -21,6 +21,11 @@ export interface MenuEntry {
     readonly id: string;
     readonly label: string;
 }
+export interface ViewAction {
+    readonly command: string;
+    readonly icon: string;
+    readonly title: string;
+}
 export interface DomEventListener {
     readonly capture?: boolean;
     readonly name: string | number;
@@ -35,6 +40,8 @@ export interface VirtualDomViewInstance {
     readonly getMenuEntries?: (menuId: string) => readonly MenuEntry[] | Promise<readonly MenuEntry[]>;
     readonly handleEvent?: (event: ViewEvent) => unknown;
     readonly render: () => readonly VirtualDomNode[] | Promise<readonly VirtualDomNode[]>;
+    readonly renderActions?: () => readonly ViewAction[] | Promise<readonly ViewAction[]>;
+    readonly renderFocus?: (oldContext: Readonly<Record<string, boolean>>, newContext: Readonly<Record<string, boolean>>) => string | Promise<string>;
     readonly saveState?: () => unknown;
 }
 export interface View {
@@ -61,9 +68,11 @@ export interface ViewRegistrySnapshot {
 }
 export interface ViewRenderResultDom {
     readonly dom: readonly VirtualDomNode[];
+    readonly focusSelector?: string;
     readonly type: 'setDom';
 }
 export interface ViewRenderResultPatches {
+    readonly focusSelector?: string;
     readonly patches: readonly unknown[];
     readonly type: 'setPatches';
 }

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

@@ -1,5 +1,5 @@
 import type { Disposable } from '../Disposable/Disposable.ts';
-import type { MenuEntry, View, ViewContext, ViewEvent, ViewRegistrySnapshot, ViewRenderResult } from '../View/View.ts';
+import type { MenuEntry, View, ViewAction, ViewContext, ViewEvent, ViewRegistrySnapshot, ViewRenderResult } from '../View/View.ts';
 export declare const registerView: (view: View) => Disposable;
 export declare const executeViewProvider: (id: string) => unknown;
 export declare const createViewInstance: (viewId: string, uid: number, context?: ViewContext) => Promise<ViewRenderResult>;
@@ -8,5 +8,6 @@ export declare const renderViewInstance: (uid: number) => Promise<ViewRenderResu
 export declare const disposeViewInstance: (uid: number) => Promise<void>;
 export declare const saveViewInstanceState: (uid: number) => Promise<unknown>;
 export declare const getViewMenuEntries: (uid: number, menuId: string) => Promise<readonly MenuEntry[]>;
+export declare const getViewActions: (uid: number) => Promise<readonly ViewAction[]>;
 export declare const getViewRegistrySnapshot: () => ViewRegistrySnapshot;
 export declare const resetViewRegistry: () => void;

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -147,6 +147,26 @@ const normalizeMenuEntries = (entries) => {
     }
     return entries.map(normalizeMenuEntry);
 };
+const normalizeViewAction = (action, index) => {
+    if (!action || typeof action !== 'object' || Array.isArray(action)) {
+        throw new ExtensionApiError(`view action ${index} must be an object`);
+    }
+    const viewAction = action;
+    assertString(viewAction.title, `view action ${index} is missing title`);
+    assertString(viewAction.icon, `view action ${index} is missing icon`);
+    assertString(viewAction.command, `view action ${index} is missing command`);
+    return {
+        command: viewAction.command,
+        icon: viewAction.icon,
+        title: viewAction.title,
+    };
+};
+const normalizeViewActions = (actions) => {
+    if (!Array.isArray(actions)) {
+        throw new ExtensionApiError('view actions must be an array');
+    }
+    return actions.map(normalizeViewAction);
+};
 const renderPatches = async (uid, instance) => {
     const oldDom = renderedDoms[uid] || [];
     const newDom = await renderDom(instance);
@@ -182,14 +202,23 @@ const isSameContext = (oldContext, newContext) => {
     }
     return true;
 };
+const unchangedContext = {
+    changed: false,
+    newContext: {},
+    oldContext: {},
+};
 const maybeNotifyContextChanged = async (uid, viewId, instance) => {
     if (typeof instance.getContext !== 'function') {
-        return;
+        return unchangedContext;
     }
     const oldContext = contexts[uid] || {};
     const newContext = normalizeContext(instance.getContext());
     if (isSameContext(oldContext, newContext)) {
-        return;
+        return {
+            changed: false,
+            newContext,
+            oldContext,
+        };
     }
     if (Object.keys(newContext).length === 0) {
         delete contexts[uid];
@@ -198,6 +227,31 @@ const maybeNotifyContextChanged = async (uid, viewId, instance) => {
         contexts[uid] = newContext;
     }
     await ExtensionManagementWorker.invoke('Extensions.handleViewContextChange', uid, viewId, newContext);
+    return {
+        changed: true,
+        newContext,
+        oldContext,
+    };
+};
+const renderFocus = async (instance, contextChange) => {
+    if (!contextChange.changed || typeof instance.renderFocus !== 'function') {
+        return '';
+    }
+    const focusSelector = await instance.renderFocus(contextChange.oldContext, contextChange.newContext);
+    if (typeof focusSelector !== 'string') {
+        throw new ExtensionApiError('view renderFocus result must be a string');
+    }
+    return focusSelector;
+};
+const withFocusSelector = async (result, instance, contextChange) => {
+    const focusSelector = await renderFocus(instance, contextChange);
+    if (!focusSelector) {
+        return result;
+    }
+    return {
+        ...result,
+        focusSelector,
+    };
 };
 const maybeClearContext = async (uid, viewId) => {
     if (!contexts[uid]) {
@@ -233,11 +287,12 @@ export const createViewInstance = async (viewId, uid, context) => {
     contextViewIds[uid] = viewId;
     const dom = await renderDom(instance);
     renderedDoms[uid] = dom;
-    await maybeNotifyContextChanged(uid, viewId, instance);
-    return {
+    const result = {
         dom,
         type: 'setDom',
     };
+    const contextChange = await maybeNotifyContextChanged(uid, viewId, instance);
+    return withFocusSelector(result, instance, contextChange);
 };
 export const dispatchViewEvent = async (uid, event) => {
     const instance = getVirtualDomInstance(uid);
@@ -245,14 +300,14 @@ export const dispatchViewEvent = async (uid, event) => {
         await instance.handleEvent(event);
     }
     const result = await renderPatches(uid, instance);
-    await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
-    return result;
+    const contextChange = await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
+    return withFocusSelector(result, instance, contextChange);
 };
 export const renderViewInstance = async (uid) => {
     const instance = getVirtualDomInstance(uid);
     const result = await renderPatches(uid, instance);
-    await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
-    return result;
+    const contextChange = await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
+    return withFocusSelector(result, instance, contextChange);
 };
 export const disposeViewInstance = async (uid) => {
     const instance = instances[uid];
@@ -279,6 +334,13 @@ export const getViewMenuEntries = async (uid, menuId) => {
     }
     return normalizeMenuEntries(await instance.getMenuEntries(menuId));
 };
+export const getViewActions = async (uid) => {
+    const instance = getVirtualDomInstance(uid);
+    if (typeof instance.renderActions !== 'function') {
+        return [];
+    }
+    return normalizeViewActions(await instance.renderActions());
+};
 export const getViewRegistrySnapshot = () => {
     return {
         views: Object.values(views).map(toRegisteredView),

package/package.json

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