@lvce-editor/api 8.41.0 → 8.43.0

package/dist/index.d.ts

@@ -6,7 +6,8 @@ export { registerCommand } from './parts/CommandRegistry/CommandRegistry.ts';
 export { executeCompletionProvider, executeResolveCompletionItemProvider, getCompletionProviderRegistrySnapshot, registerCompletionProvider, resetCompletionProviderRegistry, } from './parts/Completion/Completion.ts';
 export { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot, registerDiagnosticProvider, resetDiagnosticProviderRegistry, } from './parts/Diagnostic/Diagnostic.ts';
 export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, registerFormattingProvider, resetFormattingProviderRegistry, } from './parts/Formatting/Formatting.ts';
-export { exists, mkdir, readDirWithFileTypes, readFile, remove, writeFile } from './parts/FileSystem/FileSystem.ts';
+export { exists, mkdir, readDirWithFileTypes, readFile, remove, stat, writeFile } from './parts/FileSystem/FileSystem.ts';
+export { confirm, getWorkspaceFolder, handleWorkspaceRefresh, openUri } from './parts/Host/Host.ts';
 export { executeHoverProvider, getHoverProviderRegistrySnapshot, registerHoverProvider, resetHoverProviderRegistry } from './parts/Hover/Hover.ts';
 export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlIsActive, registerSourceControlProvider, resetSourceControlProviderRegistry, } from './parts/SourceControl/SourceControl.ts';
 export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, } from './parts/ViewRegistry/ViewRegistry.ts';
@@ -14,6 +15,7 @@ export { createOutputChannel, getOutputChannelRegistrySnapshot, resetOutputChann
 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 { handleExtensionManagementMessagePort } from './parts/HandleExtensionManagementMessagePort/HandleExtensionManagementMessagePort.ts';
+export { createNodeRpc, createRpc } from './parts/Rpc/Rpc.ts';
 export type { Command } from './parts/Command/Command.ts';
 export type { CommandCallback } from './parts/CommandCallback/CommandCallback.ts';
 export type { CommandRegistrySnapshot } from './parts/CommandRegistrySnapshot/CommandRegistrySnapshot.ts';
@@ -28,6 +30,7 @@ export type { OutputChannel } from './parts/OutputChannelHandle/OutputChannelHan
 export type { OutputChannelRegistrySnapshot } from './parts/OutputChannelRegistrySnapshot/OutputChannelRegistrySnapshot.ts';
 export type { RegisteredOutputChannel } from './parts/RegisteredOutputChannel/RegisteredOutputChannel.ts';
 export type { QuickPickItem } from './parts/QuickPickItem/QuickPickItem.ts';
+export type { CreateNodeRpcOptions, CreateRpcOptions } from './parts/Rpc/Rpc.ts';
 export type { RegisteredSourceControlProvider, SourceControlProvider, SourceControlProviderRegistrySnapshot, } from './parts/SourceControl/SourceControl.ts';
 export type { ShowQuickPickOptions } from './parts/ShowQuickPickOptions/ShowQuickPickOptions.ts';
 export type { StatusBarItem, StatusBarItemProvider, StatusBarItemProviderHandle, StatusBarItemProviderRegistrySnapshot, } from './parts/StatusBar/StatusBar.ts';

package/dist/index.js

@@ -6,10 +6,12 @@ export { registerCommand } from "./parts/CommandRegistry/CommandRegistry.js";
 export { executeCompletionProvider, executeResolveCompletionItemProvider, getCompletionProviderRegistrySnapshot, registerCompletionProvider, resetCompletionProviderRegistry, } from "./parts/Completion/Completion.js";
 export { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot, registerDiagnosticProvider, resetDiagnosticProviderRegistry, } from "./parts/Diagnostic/Diagnostic.js";
 export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, registerFormattingProvider, resetFormattingProviderRegistry, } from "./parts/Formatting/Formatting.js";
-export { exists, mkdir, readDirWithFileTypes, readFile, remove, writeFile } from "./parts/FileSystem/FileSystem.js";
+export { exists, mkdir, readDirWithFileTypes, readFile, remove, stat, writeFile } from "./parts/FileSystem/FileSystem.js";
+export { confirm, getWorkspaceFolder, handleWorkspaceRefresh, openUri } from "./parts/Host/Host.js";
 export { executeHoverProvider, getHoverProviderRegistrySnapshot, registerHoverProvider, resetHoverProviderRegistry } from "./parts/Hover/Hover.js";
 export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlIsActive, registerSourceControlProvider, resetSourceControlProviderRegistry, } from "./parts/SourceControl/SourceControl.js";
 export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, } from "./parts/ViewRegistry/ViewRegistry.js";
 export { createOutputChannel, getOutputChannelRegistrySnapshot, resetOutputChannelRegistry } from "./parts/OutputChannel/OutputChannel.js";
 export { getStatusBarItemProviderRegistrySnapshot, registerStatusBarItemProvider, resetStatusBarItemProviderRegistry, } from "./parts/StatusBar/StatusBar.js";
 export { handleExtensionManagementMessagePort } from "./parts/HandleExtensionManagementMessagePort/HandleExtensionManagementMessagePort.js";
+export { createNodeRpc, createRpc } from "./parts/Rpc/Rpc.js";

package/dist/parts/FileSystem/FileSystem.d.ts

@@ -4,5 +4,6 @@ export declare const readDirWithFileTypes: (uri: string) => Promise<readonly Fil
 export declare const readFile: (uri: string) => Promise<string>;
 export declare const mkdir: (uri: string) => Promise<void>;
 export declare const remove: (uri: string) => Promise<void>;
+export declare const stat: (uri: string) => Promise<unknown>;
 export declare const writeFile: (uri: string, content: string) => Promise<void>;
 export type { FileSystemDirent } from '../FileSystemDirent/FileSystemDirent.ts';

package/dist/parts/FileSystem/FileSystem.js

@@ -21,6 +21,9 @@ export const mkdir = async (uri) => {
 export const remove = async (uri) => {
     await FileSystemWorker.remove(uri);
 };
+export const stat = async (uri) => {
+    return FileSystemWorker.stat(uri);
+};
 export const writeFile = async (uri, content) => {
     await FileSystemWorker.writeFile(uri, content);
 };

package/dist/parts/Host/Host.d.ts

@@ -0,0 +1,4 @@
+export declare const confirm: (message: string) => Promise<boolean>;
+export declare const getWorkspaceFolder: () => Promise<string>;
+export declare const handleWorkspaceRefresh: () => Promise<void>;
+export declare const openUri: (uri: string) => Promise<void>;

package/dist/parts/Host/Host.js

@@ -0,0 +1,13 @@
+import { executeCommand } from "../ExecuteCommand/ExecuteCommand.js";
+export const confirm = async (message) => {
+    return Boolean(await executeCommand('ConfirmPrompt.prompt', message));
+};
+export const getWorkspaceFolder = async () => {
+    return (await executeCommand('Workspace.getPath'));
+};
+export const handleWorkspaceRefresh = async () => {
+    await executeCommand('Layout.handleWorkspaceRefresh');
+};
+export const openUri = async (uri) => {
+    await executeCommand('Main.openUri', uri);
+};

package/dist/parts/Rpc/Rpc.d.ts

@@ -0,0 +1,12 @@
+import { type Rpc } from '@lvce-editor/rpc';
+export interface CreateRpcOptions {
+    readonly commandMap?: Record<string, unknown>;
+    readonly name?: string;
+    readonly url: string;
+}
+export interface CreateNodeRpcOptions {
+    readonly name?: string;
+    readonly path: string;
+}
+export declare const createRpc: ({ commandMap, name, url }: CreateRpcOptions) => Promise<Rpc>;
+export declare const createNodeRpc: ({ path }: CreateNodeRpcOptions) => Promise<Rpc>;

package/dist/parts/Rpc/Rpc.js

@@ -0,0 +1,20 @@
+import { LazyTransferMessagePortRpcParent, ModuleWorkerRpcParent } from '@lvce-editor/rpc';
+import { ExtensionManagementWorker } from '@lvce-editor/rpc-registry';
+const sendMessagePortToNode = async (port) => {
+    await ExtensionManagementWorker.invokeAndTransfer('Extensions.sendMessagePortToElectron', port, 'HandleMessagePortForExtensionHostHelperProcess.handleMessagePortForExtensionHostHelperProcess');
+};
+export const createRpc = async ({ commandMap = {}, name = '', url }) => {
+    return ModuleWorkerRpcParent.create({
+        commandMap,
+        name,
+        url,
+    });
+};
+export const createNodeRpc = async ({ path }) => {
+    const rpc = await LazyTransferMessagePortRpcParent.create({
+        commandMap: {},
+        send: sendMessagePortToNode,
+    });
+    await rpc.invoke('LoadFile.loadFile', path);
+    return rpc;
+};

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

@@ -42,6 +42,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 renderTitle?: () => string | Promise<string>;
     readonly saveState?: () => unknown;
 }
 export type ViewCommand<State = VirtualDomViewInstance, Args extends readonly any[] = readonly any[]> = (state: State, ...args: Args) => State | Promise<State>;
@@ -71,11 +72,13 @@ export interface ViewRegistrySnapshot {
 export interface ViewRenderResultDom {
     readonly dom: readonly VirtualDomNode[];
     readonly focusSelector?: string;
+    readonly title?: string;
     readonly type: 'setDom';
 }
 export interface ViewRenderResultPatches {
     readonly focusSelector?: string;
     readonly patches: readonly unknown[];
+    readonly title?: string;
     readonly type: 'setPatches';
 }
 export type ViewRenderResult = ViewRenderResultDom | ViewRenderResultPatches;

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -323,6 +323,23 @@ const withFocusSelector = async (result, instance, contextChange) => {
         focusSelector,
     };
 };
+const withTitle = async (result, instance) => {
+    if (typeof instance.renderTitle !== 'function') {
+        return result;
+    }
+    const title = await instance.renderTitle();
+    if (typeof title !== 'string') {
+        throw new ExtensionApiError('view renderTitle result must be a string');
+    }
+    return {
+        ...result,
+        title,
+    };
+};
+const withRenderMetadata = async (result, instance, contextChange) => {
+    const resultWithFocus = await withFocusSelector(result, instance, contextChange);
+    return withTitle(resultWithFocus, instance);
+};
 const maybeClearContext = async (uid, viewId) => {
     if (!contexts[uid]) {
         return;
@@ -365,7 +382,7 @@ export const createViewInstance = async (viewId, uid, context) => {
         type: 'setDom',
     };
     const contextChange = await maybeNotifyContextChanged(uid, viewId, instance);
-    return withFocusSelector(result, instance, contextChange);
+    return withRenderMetadata(result, instance, contextChange);
 };
 export const dispatchViewEvent = async (uid, event) => {
     const instance = getVirtualDomInstance(uid);
@@ -377,13 +394,13 @@ export const dispatchViewEvent = async (uid, event) => {
     }
     const result = await renderPatches(uid, instance);
     const contextChange = await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
-    return withFocusSelector(result, instance, contextChange);
+    return withRenderMetadata(result, instance, contextChange);
 };
 export const renderViewInstance = async (uid) => {
     const instance = getVirtualDomInstance(uid);
     const result = await renderPatches(uid, instance);
     const contextChange = await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
-    return withFocusSelector(result, instance, contextChange);
+    return withRenderMetadata(result, instance, contextChange);
 };
 export const disposeViewInstance = async (uid) => {
     const instance = instances[uid];

package/package.json

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