@lvce-editor/api 8.43.1 → 8.45.0

package/dist/index.d.ts

@@ -9,11 +9,13 @@ export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, regis
 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 { 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 { 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';
 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/index.js

@@ -9,6 +9,7 @@ export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, regis
 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 { registerBraceCompletionProvider, registerClosingTagProvider, registerCodeActionsProvider, registerCommentProvider, registerDefinitionProvider, registerImplementationProvider, registerReferenceProvider, registerRenameProvider, registerSelectionProvider, registerTabCompletionProvider, registerTypeDefinitionProvider, resetLanguageProviderRegistry, } from "./parts/LanguageProvider/LanguageProvider.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";

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

@@ -8,6 +8,12 @@ export declare const commandMap: {
     'ExtensionApi.executeDiagnosticProvider': (textDocument: import("../DiagnosticTextDocument/DiagnosticTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../DiagnosticResult/DiagnosticResult.ts").Diagnostic[]>;
     'ExtensionApi.executeFormattingProvider': (textDocument: import("../FormattingTextDocument/FormattingTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../FormattingEdit/FormattingEdit.ts").FormattingEdit[]>;
     'ExtensionApi.executeHoverProvider': (textDocument: import("../HoverTextDocument/HoverTextDocument.ts").TextDocument, offset: number, ...args: readonly unknown[]) => Promise<import("../HoverResult/HoverResult.ts").HoverResult | undefined>;
+    'ExtensionApi.executeLanguageProvider': (kind: string, methodName: string, textDocument: {
+        readonly languageId: string;
+    }, ...args: readonly unknown[]) => Promise<unknown>;
+    'ExtensionApi.executeOrganizeImportsProvider': (textDocument: {
+        readonly languageId: string;
+    }) => Promise<unknown>;
     'ExtensionApi.executeResolveCompletionItemProvider': (textDocument: import("../CompletionTextDocument/CompletionTextDocument.ts").TextDocument, offset: number, name: string, completionItem: import("../CompletionItem/CompletionItem.ts").CompletionItem, ...args: readonly unknown[]) => Promise<import("../CompletionItem/CompletionItem.ts").CompletionItem | undefined>;
     'ExtensionApi.executeSourceControlAcceptInput': (id: string, value: string) => Promise<unknown>;
     'ExtensionApi.executeSourceControlAdd': (id: string, path: string) => Promise<unknown>;

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

@@ -7,6 +7,12 @@ export declare const commandMap: {
     'ExtensionApi.executeDiagnosticProvider': (textDocument: import("../DiagnosticTextDocument/DiagnosticTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../DiagnosticResult/DiagnosticResult.ts").Diagnostic[]>;
     'ExtensionApi.executeFormattingProvider': (textDocument: import("../FormattingTextDocument/FormattingTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../FormattingEdit/FormattingEdit.ts").FormattingEdit[]>;
     'ExtensionApi.executeHoverProvider': (textDocument: import("../HoverTextDocument/HoverTextDocument.ts").TextDocument, offset: number, ...args: readonly unknown[]) => Promise<import("../HoverResult/HoverResult.ts").HoverResult | undefined>;
+    'ExtensionApi.executeLanguageProvider': (kind: string, methodName: string, textDocument: {
+        readonly languageId: string;
+    }, ...args: readonly unknown[]) => Promise<unknown>;
+    'ExtensionApi.executeOrganizeImportsProvider': (textDocument: {
+        readonly languageId: string;
+    }) => Promise<unknown>;
     'ExtensionApi.executeResolveCompletionItemProvider': (textDocument: import("../CompletionTextDocument/CompletionTextDocument.ts").TextDocument, offset: number, name: string, completionItem: import("../CompletionItem/CompletionItem.ts").CompletionItem, ...args: readonly unknown[]) => Promise<import("../CompletionItem/CompletionItem.ts").CompletionItem | undefined>;
     'ExtensionApi.executeSourceControlAcceptInput': (id: string, value: string) => Promise<unknown>;
     'ExtensionApi.executeSourceControlAdd': (id: string, path: string) => Promise<unknown>;

package/dist/parts/ExtensionApiCommandMap/ExtensionApiCommandMap.js

@@ -4,6 +4,7 @@ import { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot } from
 import { executeFormattingProvider, getFormattingProviderRegistrySnapshot } from "../Formatting/Formatting.js";
 import { getStatusBarItems } from "../GetStatusBarItems/GetStatusBarItems.js";
 import { executeHoverProvider, getHoverProviderRegistrySnapshot } from "../Hover/Hover.js";
+import { executeLanguageProvider, executeOrganizeImportsProvider } from "../LanguageProvider/LanguageProvider.js";
 import { getOutputChannelRegistrySnapshot } from "../OutputChannel/OutputChannel.js";
 import { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlIsActive, getSourceControlProviderRegistrySnapshot, } from "../SourceControl/SourceControl.js";
 import { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewActions, getViewMenuEntries, getViewRegistrySnapshot, renderViewInstance, saveViewInstanceState, } from "../ViewRegistry/ViewRegistry.js";
@@ -16,6 +17,8 @@ export const commandMap = {
     'ExtensionApi.executeDiagnosticProvider': executeDiagnosticProvider,
     'ExtensionApi.executeFormattingProvider': executeFormattingProvider,
     'ExtensionApi.executeHoverProvider': executeHoverProvider,
+    'ExtensionApi.executeLanguageProvider': executeLanguageProvider,
+    'ExtensionApi.executeOrganizeImportsProvider': executeOrganizeImportsProvider,
     'ExtensionApi.executeResolveCompletionItemProvider': executeResolveCompletionItemProvider,
     'ExtensionApi.executeSourceControlAcceptInput': executeSourceControlAcceptInput,
     'ExtensionApi.executeSourceControlAdd': executeSourceControlAdd,

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

@@ -9,6 +9,12 @@ export declare const commandMap: {
     'ExtensionApi.executeDiagnosticProvider': (textDocument: import("../DiagnosticTextDocument/DiagnosticTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../DiagnosticResult/DiagnosticResult.ts").Diagnostic[]>;
     'ExtensionApi.executeFormattingProvider': (textDocument: import("../FormattingTextDocument/FormattingTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../FormattingEdit/FormattingEdit.ts").FormattingEdit[]>;
     'ExtensionApi.executeHoverProvider': (textDocument: import("../HoverTextDocument/HoverTextDocument.ts").TextDocument, offset: number, ...args: readonly unknown[]) => Promise<import("../HoverResult/HoverResult.ts").HoverResult | undefined>;
+    'ExtensionApi.executeLanguageProvider': (kind: string, methodName: string, textDocument: {
+        readonly languageId: string;
+    }, ...args: readonly unknown[]) => Promise<unknown>;
+    'ExtensionApi.executeOrganizeImportsProvider': (textDocument: {
+        readonly languageId: string;
+    }) => Promise<unknown>;
     'ExtensionApi.executeResolveCompletionItemProvider': (textDocument: import("../CompletionTextDocument/CompletionTextDocument.ts").TextDocument, offset: number, name: string, completionItem: import("../CompletionItem/CompletionItem.ts").CompletionItem, ...args: readonly unknown[]) => Promise<import("../CompletionItem/CompletionItem.ts").CompletionItem | undefined>;
     'ExtensionApi.executeSourceControlAcceptInput': (id: string, value: string) => Promise<unknown>;
     'ExtensionApi.executeSourceControlAdd': (id: string, path: string) => Promise<unknown>;

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

@@ -0,0 +1,24 @@
+import type { Disposable } from '../Disposable/Disposable.ts';
+export interface LanguageProvider {
+    readonly id: string;
+    readonly languageId: string;
+    readonly [key: string]: unknown;
+}
+export declare const executeLanguageProvider: (kind: string, methodName: string, textDocument: {
+    readonly languageId: string;
+}, ...args: readonly unknown[]) => Promise<unknown>;
+export declare const executeOrganizeImportsProvider: (textDocument: {
+    readonly languageId: string;
+}) => Promise<unknown>;
+export declare const registerBraceCompletionProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerClosingTagProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerCodeActionsProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerCommentProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerDefinitionProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerImplementationProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerReferenceProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerRenameProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerSelectionProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerTabCompletionProvider: (provider: LanguageProvider) => Disposable;
+export declare const registerTypeDefinitionProvider: (provider: LanguageProvider) => Disposable;
+export declare const resetLanguageProviderRegistry: () => void;

package/dist/parts/LanguageProvider/LanguageProvider.js

@@ -0,0 +1,77 @@
+import { ExtensionApiError } from "../ExtensionApiError/ExtensionApiError.js";
+const providers = Object.create(null);
+const getProvider = (kind, languageId) => {
+    return providers[kind]?.find((provider) => provider.languageId === languageId);
+};
+const registerProvider = (kind, provider, requiredMethods) => {
+    if (!provider || typeof provider !== 'object') {
+        throw new ExtensionApiError(`${kind} provider is not defined`);
+    }
+    if (typeof provider.id !== 'string' || provider.id.length === 0) {
+        throw new ExtensionApiError(`${kind} provider is missing id`);
+    }
+    if (typeof provider.languageId !== 'string' || provider.languageId.length === 0) {
+        throw new ExtensionApiError(`${kind} provider ${provider.id} is missing languageId`);
+    }
+    for (const methodName of requiredMethods) {
+        if (typeof provider[methodName] !== 'function') {
+            throw new ExtensionApiError(`${kind} provider ${provider.id} is missing ${methodName} function`);
+        }
+    }
+    const kindProviders = (providers[kind] ||= []);
+    if (kindProviders.some((registeredProvider) => registeredProvider.id === provider.id)) {
+        throw new ExtensionApiError(`${kind} provider ${provider.id} is already registered`);
+    }
+    kindProviders.push(provider);
+    return {
+        dispose() {
+            const index = kindProviders.indexOf(provider);
+            if (index !== -1) {
+                kindProviders.splice(index, 1);
+            }
+        },
+    };
+};
+export const executeLanguageProvider = async (kind, methodName, textDocument, ...args) => {
+    const provider = getProvider(kind, textDocument.languageId);
+    if (!provider) {
+        throw new ExtensionApiError(`No ${kind} provider found for ${textDocument.languageId}`);
+    }
+    const method = provider[methodName];
+    if (typeof method !== 'function') {
+        throw new ExtensionApiError(`${kind} provider ${provider.id} is missing ${methodName} function`);
+    }
+    return method(textDocument, ...args);
+};
+export const executeOrganizeImportsProvider = async (textDocument) => {
+    const provider = getProvider('code action', textDocument.languageId);
+    if (!provider) {
+        throw new ExtensionApiError(`No code action provider found for ${textDocument.languageId}`);
+    }
+    const provideCodeActions = provider.provideCodeActions;
+    const actions = await provideCodeActions(textDocument);
+    if (!Array.isArray(actions)) {
+        throw new ExtensionApiError('invalid code action result: code actions must be of type array');
+    }
+    const action = actions.find((candidate) => candidate && typeof candidate === 'object' && candidate.kind === 'source.organizeImports');
+    if (!action || typeof action.execute !== 'function') {
+        return [];
+    }
+    return action.execute(textDocument);
+};
+export const registerBraceCompletionProvider = (provider) => registerProvider('brace completion', provider, ['provideBraceCompletion']);
+export const registerClosingTagProvider = (provider) => registerProvider('closing tag', provider, ['provideClosingTag']);
+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 registerImplementationProvider = (provider) => registerProvider('implementation', provider, ['provideImplementations']);
+export const registerReferenceProvider = (provider) => registerProvider('reference', provider, ['provideReferences']);
+export const registerRenameProvider = (provider) => registerProvider('rename', provider, ['provideRename']);
+export const registerSelectionProvider = (provider) => registerProvider('selection', provider, ['provideSelections']);
+export const registerTabCompletionProvider = (provider) => registerProvider('tab completion', provider, ['provideTabCompletion']);
+export const registerTypeDefinitionProvider = (provider) => registerProvider('type definition', provider, ['provideTypeDefinition']);
+export const resetLanguageProviderRegistry = () => {
+    for (const kind of Object.keys(providers)) {
+        delete providers[kind];
+    }
+};

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.45.0",
   "description": "Tree-shakeable extension API for Lvce Editor extensions.",
   "keywords": [
     "lvce-editor",