@lvce-editor/api 8.43.1 → 8.44.0

package/dist/index.d.ts

@@ -13,7 +13,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, ViewAction, ViewCommand, ViewContext, ViewEvent, ViewKind, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, VirtualDomViewInstance, } from './parts/View/View.ts';
+export type { RegisteredView, View, ViewAction, ViewCommand, ViewContext, ViewEvent, ViewKind, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, 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/parts/View/View.d.ts

@@ -26,6 +26,11 @@ export interface ViewAction {
     readonly icon: string;
     readonly title: string;
 }
+export interface ViewSelection {
+    readonly end: number;
+    readonly name: string;
+    readonly start: number;
+}
 export interface DomEventListener {
     readonly capture?: boolean;
     readonly name: string | number;
@@ -42,6 +47,7 @@ export interface VirtualDomViewInstance {
     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 renderSelections?: () => readonly ViewSelection[] | Promise<readonly ViewSelection[]>;
     readonly renderTitle?: () => string | Promise<string>;
     readonly saveState?: () => unknown;
 }
@@ -72,12 +78,14 @@ export interface ViewRegistrySnapshot {
 export interface ViewRenderResultDom {
     readonly dom: readonly VirtualDomNode[];
     readonly focusSelector?: string;
+    readonly selections?: readonly ViewSelection[];
     readonly title?: string;
     readonly type: 'setDom';
 }
 export interface ViewRenderResultPatches {
     readonly focusSelector?: string;
     readonly patches: readonly unknown[];
+    readonly selections?: readonly ViewSelection[];
     readonly title?: string;
     readonly type: 'setPatches';
 }

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -237,6 +237,26 @@ const normalizeViewActions = (actions) => {
     }
     return actions.map(normalizeViewAction);
 };
+const normalizeViewSelection = (selection, index) => {
+    if (!selection || typeof selection !== 'object' || Array.isArray(selection)) {
+        throw new ExtensionApiError(`view selection ${index} must be an object`);
+    }
+    const viewSelection = selection;
+    assertString(viewSelection.name, `view selection ${index} is missing name`);
+    assertNumber(viewSelection.start, `view selection ${index} is missing start`);
+    assertNumber(viewSelection.end, `view selection ${index} is missing end`);
+    return {
+        end: viewSelection.end,
+        name: viewSelection.name,
+        start: viewSelection.start,
+    };
+};
+const normalizeViewSelections = (selections) => {
+    if (!Array.isArray(selections)) {
+        throw new ExtensionApiError('view selections must be an array');
+    }
+    return selections.map(normalizeViewSelection);
+};
 const renderPatches = async (uid, instance) => {
     const oldDom = renderedDoms[uid] || [];
     const newDom = await renderDom(instance);
@@ -336,9 +356,23 @@ const withTitle = async (result, instance) => {
         title,
     };
 };
+const withSelections = async (result, instance) => {
+    if (typeof instance.renderSelections !== 'function') {
+        return result;
+    }
+    const selections = normalizeViewSelections(await instance.renderSelections());
+    if (selections.length === 0) {
+        return result;
+    }
+    return {
+        ...result,
+        selections,
+    };
+};
 const withRenderMetadata = async (result, instance, contextChange) => {
     const resultWithFocus = await withFocusSelector(result, instance, contextChange);
-    return withTitle(resultWithFocus, instance);
+    const resultWithSelections = await withSelections(resultWithFocus, instance);
+    return withTitle(resultWithSelections, instance);
 };
 const maybeClearContext = async (uid, viewId) => {
     if (!contexts[uid]) {

package/package.json

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