@lvce-editor/api 9.22.0 → 9.23.0

package/README.md

@@ -30,12 +30,13 @@ import { getUserDataDir } from '@lvce-editor/api'
 const userDataDir = await getUserDataDir()
 ```
 
-Electron extensions can create an off-screen web contents view. It stays hidden for the lifetime of the handle, and disposing the handle destroys its web contents.
+Electron extensions can create a web contents view, hide it from the editor window, and continue using its web contents. Disposing the handle destroys its web contents.
 
 ```ts
 import { createElectronWebContentsView } from '@lvce-editor/api'
 
 const view = await createElectronWebContentsView({ url: 'https://example.com' })
+await view.hide()
 const title = await view.executeJavaScript<string>('document.title')
 await view.dispose()
 ```

package/dist/index.d.ts

@@ -23,8 +23,8 @@ export { focusNextTab, focusPreviousTab } from './parts/MainArea/MainArea.ts';
 export { openProcessExplorer } from './parts/ProcessExplorer/ProcessExplorer.ts';
 export { openDebugConsole, openOutputView, openProblemsView, type OpenDebugConsoleOptions, type OpenOutputViewOptions, type OpenProblemsViewOptions, } from './parts/Panel/Panel.ts';
 export { getLanguageServerRegistrySnapshot, registerLanguageServer, resetLanguageServerRegistry } from './parts/LanguageServer/LanguageServer.ts';
-export { registerBraceCompletionProvider, registerClosingTagProvider, registerCodeActionsProvider, registerCommentProvider, registerDefinitionProvider, registerImplementationProvider, registerReferenceProvider, registerRenameProvider, registerSelectionProvider, registerTabCompletionProvider, registerTypeDefinitionProvider, resetLanguageProviderRegistry, } from './parts/LanguageProvider/LanguageProvider.ts';
-export type { LanguageProvider } from './parts/LanguageProvider/LanguageProvider.ts';
+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 { createOutputChannel, getOutputChannelLogs, getOutputChannelRegistrySnapshot, resetOutputChannelRegistry, } from './parts/OutputChannel/OutputChannel.ts';

package/dist/index.js

@@ -23,7 +23,7 @@ export { focusNextTab, focusPreviousTab } from "./parts/MainArea/MainArea.js";
 export { openProcessExplorer } from "./parts/ProcessExplorer/ProcessExplorer.js";
 export { openDebugConsole, openOutputView, openProblemsView, } from "./parts/Panel/Panel.js";
 export { getLanguageServerRegistrySnapshot, registerLanguageServer, resetLanguageServerRegistry } from "./parts/LanguageServer/LanguageServer.js";
-export { registerBraceCompletionProvider, registerClosingTagProvider, registerCodeActionsProvider, registerCommentProvider, registerDefinitionProvider, registerImplementationProvider, registerReferenceProvider, registerRenameProvider, registerSelectionProvider, registerTabCompletionProvider, registerTypeDefinitionProvider, resetLanguageProviderRegistry, } from "./parts/LanguageProvider/LanguageProvider.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 { createOutputChannel, getOutputChannelLogs, getOutputChannelRegistrySnapshot, resetOutputChannelRegistry, } from "./parts/OutputChannel/OutputChannel.js";

package/dist/parts/ElectronWebContentsView/ElectronWebContentsView.d.ts

@@ -12,6 +12,7 @@ export interface ElectronWebContentsView {
     readonly dispose: () => Promise<void>;
     readonly executeJavaScript: <T = unknown>(code: string, userGesture?: boolean) => Promise<T>;
     readonly getStats: () => Promise<ElectronWebContentsViewStats>;
+    readonly hide: () => Promise<void>;
     readonly loadUrl: (url: string) => Promise<void>;
     readonly reload: () => Promise<void>;
 }

package/dist/parts/ElectronWebContentsView/ElectronWebContentsView.js

@@ -54,6 +54,9 @@ export const createElectronWebContentsView = async ({ url } = {}) => {
         async getStats() {
             return (await rpc.invoke('ElectronWebContentsView.getStats', id));
         },
+        async hide() {
+            await rpc.invoke('ElectronWebContentsView.hide', id);
+        },
         loadUrl,
         async reload() {
             await rpc.invoke('ElectronWebContentsView.reload', id);

package/dist/parts/LanguageProvider/LanguageProvider.d.ts

@@ -4,6 +4,25 @@ export interface LanguageProvider {
     readonly languageId: string;
     readonly [key: string]: unknown;
 }
+export interface DocumentSymbol {
+    readonly children?: readonly DocumentSymbol[];
+    readonly detail?: string;
+    readonly endOffset: number;
+    readonly kind: number | string;
+    readonly name: string;
+    readonly selectionEndOffset: number;
+    readonly selectionStartOffset: number;
+    readonly startOffset: number;
+}
+export interface DocumentSymbolTextDocument {
+    readonly documentId?: number;
+    readonly languageId: string;
+    readonly text: string;
+    readonly uri: string;
+}
+export interface DocumentSymbolProvider extends LanguageProvider {
+    readonly provideDocumentSymbols: (textDocument: DocumentSymbolTextDocument) => Promise<readonly DocumentSymbol[]> | readonly DocumentSymbol[];
+}
 export declare const executeLanguageProvider: (kind: string, methodName: string, textDocument: {
     readonly languageId: string;
 }, ...args: readonly unknown[]) => Promise<unknown>;
@@ -15,6 +34,7 @@ export declare const registerClosingTagProvider: (provider: LanguageProvider) =>
 export declare const registerCodeActionsProvider: (provider: LanguageProvider) => Disposable;
 export declare const registerCommentProvider: (provider: LanguageProvider) => Disposable;
 export declare const registerDefinitionProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerDocumentSymbolProvider: (provider: DocumentSymbolProvider) => Disposable;
 export declare const registerImplementationProvider: (provider: LanguageProvider) => Disposable;
 export declare const registerReferenceProvider: (provider: LanguageProvider) => Disposable;
 export declare const registerRenameProvider: (provider: LanguageProvider) => Disposable;

package/dist/parts/LanguageProvider/LanguageProvider.js

@@ -66,6 +66,7 @@ export const registerClosingTagProvider = (provider) => registerProvider('closin
 export const registerCodeActionsProvider = (provider) => registerProvider('code action', provider, ['provideCodeActions']);
 export const registerCommentProvider = (provider) => registerProvider('comment', provider, ['provideComment']);
 export const registerDefinitionProvider = (provider) => registerProvider('definition', provider, ['provideDefinition']);
+export const registerDocumentSymbolProvider = (provider) => registerProvider('document symbol', provider, ['provideDocumentSymbols']);
 export const registerImplementationProvider = (provider) => registerProvider('implementation', provider, ['provideImplementations']);
 export const registerReferenceProvider = (provider) => registerProvider('reference', provider, ['provideReferences']);
 export const registerRenameProvider = (provider) => registerProvider('rename', provider, ['provideRename']);

package/package.json

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