@lvce-editor/api 8.50.0 → 8.52.0

package/dist/index.d.ts

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

@@ -5,8 +5,9 @@ export interface CreateRpcOptions {
     readonly url: string;
 }
 export interface CreateNodeRpcOptions {
+    readonly id?: string;
     readonly name?: string;
-    readonly path: string;
+    readonly path?: string;
 }
 export declare const createRpc: ({ commandMap, name, url }: CreateRpcOptions) => Promise<Rpc>;
-export declare const createNodeRpc: ({ name, path }: CreateNodeRpcOptions) => Promise<Rpc>;
+export declare const createNodeRpc: (options: CreateNodeRpcOptions) => Promise<Rpc>;

package/dist/parts/Rpc/Rpc.js

@@ -17,14 +17,24 @@ const createMessagePortRpc = async (commandMap, send) => {
 export const createRpc = async ({ commandMap = {}, name = '', url }) => {
     return createMessagePortRpc(commandMap, (port) => sendMessagePortToWebWorker(port, name, url));
 };
-export const createNodeRpc = async ({ name = '', path }) => {
-    const id = await ExtensionManagementWorker.invoke('Extensions.executeCommand', 'ExtensionNodeRpc.create', name, path);
+const resolveNodeRpcOptions = async ({ id, name = '', path }) => {
+    if (id) {
+        return ExtensionManagementWorker.invoke('Extensions.getNodeRpcInfo', id);
+    }
+    if (path) {
+        return { name, path };
+    }
+    throw new TypeError('createNodeRpc requires an id or path');
+};
+export const createNodeRpc = async (options) => {
+    const { name, path } = await resolveNodeRpcOptions(options);
+    const rpcId = await ExtensionManagementWorker.invoke('Extensions.executeCommand', 'ExtensionNodeRpc.create', name, path);
     const invoke = (method, ...params) => {
-        return ExtensionManagementWorker.invoke('Extensions.executeCommand', 'ExtensionNodeRpc.invoke', id, method, ...params);
+        return ExtensionManagementWorker.invoke('Extensions.executeCommand', 'ExtensionNodeRpc.invoke', rpcId, method, ...params);
     };
     return {
         async dispose() {
-            await ExtensionManagementWorker.invoke('Extensions.executeCommand', 'ExtensionNodeRpc.dispose', id);
+            await ExtensionManagementWorker.invoke('Extensions.executeCommand', 'ExtensionNodeRpc.dispose', rpcId);
         },
         invoke,
         invokeAndTransfer: invoke,

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

@@ -31,6 +31,7 @@ export interface ViewSelection {
     readonly name: string;
     readonly start: number;
 }
+export type ViewScrollPosition = readonly [selector: string, scrollTop: number];
 export interface DomEventListener {
     readonly capture?: boolean;
     readonly name: string | number;
@@ -48,6 +49,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 renderScrollPosition?: () => readonly [] | ViewScrollPosition | Promise<readonly [] | ViewScrollPosition>;
     readonly renderSelections?: () => readonly ViewSelection[] | Promise<readonly ViewSelection[]>;
     readonly renderTitle?: () => string | Promise<string>;
     readonly saveState?: () => unknown;
@@ -79,6 +81,7 @@ export interface ViewRegistrySnapshot {
 export interface ViewRenderResultDom {
     readonly dom: readonly VirtualDomNode[];
     readonly focusSelector?: string;
+    readonly scrollPosition?: ViewScrollPosition;
     readonly selections?: readonly ViewSelection[];
     readonly title?: string;
     readonly type: 'setDom';
@@ -86,6 +89,7 @@ export interface ViewRenderResultDom {
 export interface ViewRenderResultPatches {
     readonly focusSelector?: string;
     readonly patches: readonly unknown[];
+    readonly scrollPosition?: ViewScrollPosition;
     readonly selections?: readonly ViewSelection[];
     readonly title?: string;
     readonly type: 'setPatches';

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -262,6 +262,20 @@ const normalizeViewSelections = (selections) => {
     }
     return selections.map(normalizeViewSelection);
 };
+const normalizeViewScrollPosition = (scrollPosition) => {
+    if (!Array.isArray(scrollPosition)) {
+        throw new ExtensionApiError('view scroll position must be an array');
+    }
+    if (scrollPosition.length === 0) {
+        return [];
+    }
+    if (scrollPosition.length !== 2) {
+        throw new ExtensionApiError('view scroll position must contain a selector and scroll top');
+    }
+    assertString(scrollPosition[0], 'view scroll position is missing selector');
+    assertNumber(scrollPosition[1], 'view scroll position is missing scroll top');
+    return [scrollPosition[0], scrollPosition[1]];
+};
 const renderPatches = async (uid, instance) => {
     const oldDom = renderedDoms[uid] || [];
     const newDom = await renderDom(instance);
@@ -374,10 +388,24 @@ const withSelections = async (result, instance) => {
         selections,
     };
 };
+const withScrollPosition = async (result, instance) => {
+    if (typeof instance.renderScrollPosition !== 'function') {
+        return result;
+    }
+    const scrollPosition = normalizeViewScrollPosition(await instance.renderScrollPosition());
+    if (scrollPosition.length === 0) {
+        return result;
+    }
+    return {
+        ...result,
+        scrollPosition,
+    };
+};
 const withRenderMetadata = async (result, instance, contextChange) => {
     const resultWithFocus = await withFocusSelector(result, instance, contextChange);
     const resultWithSelections = await withSelections(resultWithFocus, instance);
-    return withTitle(resultWithSelections, instance);
+    const resultWithScrollPosition = await withScrollPosition(resultWithSelections, instance);
+    return withTitle(resultWithScrollPosition, instance);
 };
 const maybeClearContext = async (uid, viewId) => {
     if (!contexts[uid]) {

package/package.json

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