@lvce-editor/extension-host-worker 8.17.0 → 8.18.0

package/extension-api/dist/parts/ProviderRegistry/ProviderRegistry.d.ts

@@ -0,0 +1,21 @@
+interface ProviderWithId {
+    readonly id: string;
+}
+interface ProviderRegistryOptions<TProvider, TRegisteredProvider extends ProviderWithId> {
+    readonly mapProvider: (provider: TProvider) => TRegisteredProvider;
+    readonly optionalMethods?: readonly string[];
+    readonly providerName: string;
+    readonly requiredMethods: readonly string[];
+    readonly requireLanguageId?: boolean;
+}
+export interface ProviderRegistry<TProvider, TRegisteredProvider extends ProviderWithId> {
+    readonly deleteProvider: (id: string) => void;
+    readonly executeProviderByLanguageId: <TResult>(languageId: string, methodName: keyof TRegisteredProvider & string, args: readonly unknown[], validateResult?: (result: unknown) => TResult) => Promise<TResult>;
+    readonly getProviderByLanguageId: (languageId: string) => TRegisteredProvider | undefined;
+    readonly getProviders: () => TRegisteredProvider[];
+    readonly hasProvider: (id: string) => boolean;
+    readonly registerProvider: (provider: TProvider) => TRegisteredProvider;
+    readonly reset: () => void;
+}
+export declare const createProviderRegistry: <TProvider, TRegisteredProvider extends ProviderWithId>({ mapProvider, optionalMethods, providerName, requiredMethods, requireLanguageId, }: ProviderRegistryOptions<TProvider, TRegisteredProvider>) => ProviderRegistry<TProvider, TRegisteredProvider>;
+export {};

package/extension-api/dist/parts/ProviderRegistry/ProviderRegistry.js

@@ -0,0 +1,86 @@
+import { ExtensionApiError } from "../ExtensionApiError/ExtensionApiError.js";
+const getProviderMethod = (provider, methodName) => {
+    const method = provider[methodName];
+    if (typeof method !== 'function') {
+        return undefined;
+    }
+    return method;
+};
+const assertProviderMethod = (provider, providerName, providerId, methodName) => {
+    if (typeof provider[methodName] !== 'function') {
+        throw new ExtensionApiError(`${providerName} ${providerId} is missing ${methodName} function`);
+    }
+};
+const assertOptionalProviderMethod = (provider, providerName, providerId, methodName) => {
+    if (provider[methodName] !== undefined && typeof provider[methodName] !== 'function') {
+        throw new ExtensionApiError(`${providerName} ${providerId} has invalid ${methodName} function`);
+    }
+};
+export const createProviderRegistry = ({ mapProvider, optionalMethods = [], providerName, requiredMethods, requireLanguageId = false, }) => {
+    const providers = Object.create(null);
+    const hasProvider = (id) => {
+        return id in providers;
+    };
+    const registerProvider = (provider) => {
+        if (!provider) {
+            throw new ExtensionApiError(`${providerName} is not defined`);
+        }
+        const providerRecord = provider;
+        const { id } = providerRecord;
+        if (typeof id !== 'string' || id.length === 0) {
+            throw new ExtensionApiError(`${providerName} is missing id`);
+        }
+        if (requireLanguageId && (typeof providerRecord.languageId !== 'string' || providerRecord.languageId.length === 0)) {
+            throw new ExtensionApiError(`${providerName} ${id} is missing languageId`);
+        }
+        for (const methodName of requiredMethods) {
+            assertProviderMethod(providerRecord, providerName, id, methodName);
+        }
+        for (const methodName of optionalMethods) {
+            assertOptionalProviderMethod(providerRecord, providerName, id, methodName);
+        }
+        if (hasProvider(id)) {
+            throw new ExtensionApiError(`${providerName} ${id} is already registered`);
+        }
+        const registeredProvider = mapProvider(provider);
+        providers[registeredProvider.id] = registeredProvider;
+        return registeredProvider;
+    };
+    const deleteProvider = (id) => {
+        delete providers[id];
+    };
+    const getProviders = () => {
+        return Object.values(providers);
+    };
+    const getProviderByLanguageId = (languageId) => {
+        return getProviders().find((provider) => {
+            return 'languageId' in provider && provider.languageId === languageId;
+        });
+    };
+    const reset = () => {
+        for (const id of Object.keys(providers)) {
+            delete providers[id];
+        }
+    };
+    const executeProviderByLanguageId = async (languageId, methodName, args, validateResult) => {
+        const provider = getProviderByLanguageId(languageId);
+        if (!provider) {
+            throw new ExtensionApiError(`No ${providerName} found for ${languageId}`);
+        }
+        const method = getProviderMethod(provider, methodName);
+        if (!method) {
+            throw new ExtensionApiError(`${providerName} ${provider.id} is missing ${methodName} function`);
+        }
+        const result = await method(...args);
+        return validateResult ? validateResult(result) : result;
+    };
+    return {
+        deleteProvider,
+        executeProviderByLanguageId,
+        getProviderByLanguageId,
+        getProviders,
+        hasProvider,
+        registerProvider,
+        reset,
+    };
+};

package/extension-api/dist/parts/QuickPick/QuickPick.d.ts

@@ -0,0 +1,2 @@
+import type { ShowQuickPickOptions } from '../ShowQuickPickOptions/ShowQuickPickOptions.ts';
+export declare const showQuickPick: (options: ShowQuickPickOptions) => Promise<unknown>;

package/extension-api/dist/parts/QuickPick/QuickPick.js

@@ -0,0 +1,4 @@
+import * as Rpc from "../Rpc/Rpc.js";
+export const showQuickPick = async (options) => {
+    return Rpc.invoke('ExtensionHostQuickPick.showQuickPick', options);
+};

package/extension-api/dist/parts/QuickPickItem/QuickPickItem.d.ts

@@ -0,0 +1,5 @@
+export interface QuickPickItem {
+    readonly description: string;
+    readonly label: string;
+    readonly value: unknown;
+}

package/extension-api/dist/parts/QuickPickItem/QuickPickItem.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/RegisterCompletionProvider/RegisterCompletionProvider.d.ts

@@ -0,0 +1 @@
+export { registerCompletionProvider } from '../CompletionProviderRegistry/CompletionProviderRegistry.ts';

package/extension-api/dist/parts/RegisterCompletionProvider/RegisterCompletionProvider.js

@@ -0,0 +1 @@
+export { registerCompletionProvider } from "../CompletionProviderRegistry/CompletionProviderRegistry.js";

package/extension-api/dist/parts/RegisterFormattingProvider/RegisterFormattingProvider.d.ts

@@ -0,0 +1 @@
+export { registerFormattingProvider } from '../FormattingProviderRegistry/FormattingProviderRegistry.ts';

package/extension-api/dist/parts/RegisterFormattingProvider/RegisterFormattingProvider.js

@@ -0,0 +1 @@
+export { registerFormattingProvider } from "../FormattingProviderRegistry/FormattingProviderRegistry.js";

package/extension-api/dist/parts/RegisterHoverProvider/RegisterHoverProvider.d.ts

@@ -0,0 +1 @@
+export { registerHoverProvider } from '../HoverProviderRegistry/HoverProviderRegistry.ts';

package/extension-api/dist/parts/RegisterHoverProvider/RegisterHoverProvider.js

@@ -0,0 +1 @@
+export { registerHoverProvider } from "../HoverProviderRegistry/HoverProviderRegistry.js";

package/extension-api/dist/parts/RegisterStatusBarItemProvider/RegisterStatusBarItemProvider.d.ts

@@ -0,0 +1 @@
+export { registerStatusBarItemProvider } from '../StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.ts';

package/extension-api/dist/parts/RegisterStatusBarItemProvider/RegisterStatusBarItemProvider.js

@@ -0,0 +1 @@
+export { registerStatusBarItemProvider } from "../StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.js";

package/extension-api/dist/parts/RegisteredCommand/RegisteredCommand.d.ts

@@ -0,0 +1,4 @@
+export interface RegisteredCommand {
+    execute(...args: readonly unknown[]): unknown | Promise<unknown>;
+    readonly id: string;
+}

package/extension-api/dist/parts/RegisteredCommand/RegisteredCommand.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/RegisteredCompletionProvider/RegisteredCompletionProvider.d.ts

@@ -0,0 +1,8 @@
+import type { CompletionItem } from '../CompletionItem/CompletionItem.ts';
+import type { TextDocument } from '../CompletionTextDocument/CompletionTextDocument.ts';
+export interface RegisteredCompletionProvider {
+    readonly id: string;
+    readonly languageId: string;
+    readonly provideCompletions: (textDocument: TextDocument, offset: number, ...args: readonly unknown[]) => readonly CompletionItem[] | Promise<readonly CompletionItem[]>;
+    readonly resolveCompletionItem?: (textDocument: TextDocument, offset: number, name: string, completionItem: CompletionItem, ...args: readonly unknown[]) => CompletionItem | undefined | Promise<CompletionItem | undefined>;
+}

package/extension-api/dist/parts/RegisteredCompletionProvider/RegisteredCompletionProvider.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/RegisteredFormattingProvider/RegisteredFormattingProvider.d.ts

@@ -0,0 +1,7 @@
+import type { FormattingEdit } from '../FormattingEdit/FormattingEdit.ts';
+import type { TextDocument } from '../FormattingTextDocument/FormattingTextDocument.ts';
+export interface RegisteredFormattingProvider {
+    readonly format: (textDocument: TextDocument, ...args: readonly unknown[]) => readonly FormattingEdit[] | Promise<readonly FormattingEdit[]>;
+    readonly id: string;
+    readonly languageId: string;
+}

package/extension-api/dist/parts/RegisteredFormattingProvider/RegisteredFormattingProvider.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/RegisteredHoverProvider/RegisteredHoverProvider.d.ts

@@ -0,0 +1,7 @@
+import type { HoverResult } from '../HoverResult/HoverResult.ts';
+import type { TextDocument } from '../HoverTextDocument/HoverTextDocument.ts';
+export interface RegisteredHoverProvider {
+    readonly id: string;
+    readonly languageId: string;
+    readonly provideHover: (textDocument: TextDocument, offset: number, ...args: readonly unknown[]) => HoverResult | undefined | Promise<HoverResult | undefined>;
+}

package/extension-api/dist/parts/RegisteredHoverProvider/RegisteredHoverProvider.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/RegisteredStatusBarItemProvider/RegisteredStatusBarItemProvider.d.ts

@@ -0,0 +1,5 @@
+import type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
+export interface RegisteredStatusBarItemProvider {
+    readonly getStatusBarItem: () => StatusBarItem | undefined;
+    readonly id: string;
+}

package/extension-api/dist/parts/RegisteredStatusBarItemProvider/RegisteredStatusBarItemProvider.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/ResetCompletionProviderRegistry/ResetCompletionProviderRegistry.d.ts

@@ -0,0 +1 @@
+export { resetCompletionProviderRegistry } from '../CompletionProviderRegistry/CompletionProviderRegistry.ts';

package/extension-api/dist/parts/ResetCompletionProviderRegistry/ResetCompletionProviderRegistry.js

@@ -0,0 +1 @@
+export { resetCompletionProviderRegistry } from "../CompletionProviderRegistry/CompletionProviderRegistry.js";

package/extension-api/dist/parts/ResetFormattingProviderRegistry/ResetFormattingProviderRegistry.d.ts

@@ -0,0 +1 @@
+export { resetFormattingProviderRegistry } from '../FormattingProviderRegistry/FormattingProviderRegistry.ts';

package/extension-api/dist/parts/ResetFormattingProviderRegistry/ResetFormattingProviderRegistry.js

@@ -0,0 +1 @@
+export { resetFormattingProviderRegistry } from "../FormattingProviderRegistry/FormattingProviderRegistry.js";

package/extension-api/dist/parts/ResetHoverProviderRegistry/ResetHoverProviderRegistry.d.ts

@@ -0,0 +1 @@
+export { resetHoverProviderRegistry } from '../HoverProviderRegistry/HoverProviderRegistry.ts';

package/extension-api/dist/parts/ResetHoverProviderRegistry/ResetHoverProviderRegistry.js

@@ -0,0 +1 @@
+export { resetHoverProviderRegistry } from "../HoverProviderRegistry/HoverProviderRegistry.js";

package/extension-api/dist/parts/ResetStatusBarItemProviderRegistry/ResetStatusBarItemProviderRegistry.d.ts

@@ -0,0 +1 @@
+export { resetStatusBarItemProviderRegistry } from '../StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.ts';

package/extension-api/dist/parts/ResetStatusBarItemProviderRegistry/ResetStatusBarItemProviderRegistry.js

@@ -0,0 +1 @@
+export { resetStatusBarItemProviderRegistry } from "../StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.js";

package/extension-api/dist/parts/Rpc/Rpc.d.ts

@@ -0,0 +1,3 @@
+import type { Rpc } from '@lvce-editor/rpc';
+export declare const set: (value: Rpc) => void;
+export declare const invoke: (method: string, ...params: readonly any[]) => Promise<any>;

package/extension-api/dist/parts/Rpc/Rpc.js

@@ -0,0 +1,10 @@
+let rpc;
+export const set = (value) => {
+    rpc = value;
+};
+export const invoke = async (method, ...params) => {
+    if (!rpc) {
+        return undefined;
+    }
+    return rpc.invoke(method, ...params);
+};

package/extension-api/dist/parts/ShowQuickPickOptions/ShowQuickPickOptions.d.ts

@@ -0,0 +1,5 @@
+import type { QuickPickItem } from '../QuickPickItem/QuickPickItem.ts';
+export interface ShowQuickPickOptions {
+    readonly items: readonly QuickPickItem[];
+    readonly placeholder?: string;
+}

package/extension-api/dist/parts/ShowQuickPickOptions/ShowQuickPickOptions.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/StatusBar/StatusBar.d.ts

@@ -0,0 +1,8 @@
+export { getStatusBarItemProviderRegistrySnapshot } from '../GetStatusBarItemProviderRegistrySnapshot/GetStatusBarItemProviderRegistrySnapshot.ts';
+export { registerStatusBarItemProvider } from '../RegisterStatusBarItemProvider/RegisterStatusBarItemProvider.ts';
+export { resetStatusBarItemProviderRegistry } from '../ResetStatusBarItemProviderRegistry/ResetStatusBarItemProviderRegistry.ts';
+export type { RegisteredStatusBarItemProvider } from '../RegisteredStatusBarItemProvider/RegisteredStatusBarItemProvider.ts';
+export type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
+export type { StatusBarItemProvider } from '../StatusBarItemProvider/StatusBarItemProvider.ts';
+export type { StatusBarItemProviderHandle } from '../StatusBarItemProviderHandle/StatusBarItemProviderHandle.ts';
+export type { StatusBarItemProviderRegistrySnapshot } from '../StatusBarItemProviderRegistrySnapshot/StatusBarItemProviderRegistrySnapshot.ts';

package/extension-api/dist/parts/StatusBar/StatusBar.js

@@ -0,0 +1,3 @@
+export { getStatusBarItemProviderRegistrySnapshot } from "../GetStatusBarItemProviderRegistrySnapshot/GetStatusBarItemProviderRegistrySnapshot.js";
+export { registerStatusBarItemProvider } from "../RegisterStatusBarItemProvider/RegisterStatusBarItemProvider.js";
+export { resetStatusBarItemProviderRegistry } from "../ResetStatusBarItemProviderRegistry/ResetStatusBarItemProviderRegistry.js";

package/extension-api/dist/parts/StatusBarItem/StatusBarItem.d.ts

@@ -0,0 +1,7 @@
+export interface StatusBarItem {
+    readonly icon?: string;
+    readonly name?: string;
+    readonly onClick?: string;
+    readonly text?: string;
+    readonly title?: string;
+}

package/extension-api/dist/parts/StatusBarItem/StatusBarItem.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/StatusBarItemProvider/StatusBarItemProvider.d.ts

@@ -0,0 +1,5 @@
+import type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
+export interface StatusBarItemProvider {
+    readonly getStatusBarItem: () => StatusBarItem | undefined;
+    readonly id: string;
+}

package/extension-api/dist/parts/StatusBarItemProvider/StatusBarItemProvider.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/StatusBarItemProviderHandle/StatusBarItemProviderHandle.d.ts

@@ -0,0 +1,4 @@
+import type { Disposable } from '../Disposable/Disposable.ts';
+export interface StatusBarItemProviderHandle extends Disposable {
+    readonly refresh: () => Promise<void>;
+}

package/extension-api/dist/parts/StatusBarItemProviderHandle/StatusBarItemProviderHandle.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.d.ts

@@ -0,0 +1,11 @@
+import type { RegisteredStatusBarItemProvider } from '../RegisteredStatusBarItemProvider/RegisteredStatusBarItemProvider.ts';
+import type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
+import type { StatusBarItemProvider } from '../StatusBarItemProvider/StatusBarItemProvider.ts';
+import type { StatusBarItemProviderHandle } from '../StatusBarItemProviderHandle/StatusBarItemProviderHandle.ts';
+import type { StatusBarItemProviderRegistrySnapshot } from '../StatusBarItemProviderRegistrySnapshot/StatusBarItemProviderRegistrySnapshot.ts';
+export declare const hasStatusBarItemProvider: (id: string) => boolean;
+export declare const registerStatusBarItemProvider: (provider: StatusBarItemProvider) => StatusBarItemProviderHandle;
+export declare const getStatusBarItemProviders: () => RegisteredStatusBarItemProvider[];
+export declare const getStatusBarItems: () => readonly StatusBarItem[];
+export declare const getStatusBarItemProviderRegistrySnapshot: () => StatusBarItemProviderRegistrySnapshot;
+export declare const resetStatusBarItemProviderRegistry: () => void;

package/extension-api/dist/parts/StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.js

@@ -0,0 +1,44 @@
+import * as NotifyStatusBarChange from "../NotifyStatusBarChange/NotifyStatusBarChange.js";
+import { createProviderRegistry } from "../ProviderRegistry/ProviderRegistry.js";
+const registry = createProviderRegistry({
+    mapProvider(provider) {
+        return {
+            getStatusBarItem() {
+                return provider.getStatusBarItem();
+            },
+            id: provider.id,
+        };
+    },
+    providerName: 'status bar item provider',
+    requiredMethods: ['getStatusBarItem'],
+});
+const getStatusBarItem = (provider) => {
+    return provider.getStatusBarItem();
+};
+const isStatusBarItem = (item) => {
+    return item !== undefined;
+};
+export const hasStatusBarItemProvider = registry.hasProvider;
+export const registerStatusBarItemProvider = (provider) => {
+    const registeredProvider = registry.registerProvider(provider);
+    void NotifyStatusBarChange.notifyStatusBarChange(registeredProvider.id);
+    return {
+        dispose() {
+            registry.deleteProvider(registeredProvider.id);
+            void NotifyStatusBarChange.notifyStatusBarChange(registeredProvider.id);
+        },
+        async refresh() {
+            await NotifyStatusBarChange.notifyStatusBarChange(registeredProvider.id);
+        },
+    };
+};
+export const getStatusBarItemProviders = registry.getProviders;
+export const getStatusBarItems = () => {
+    return registry.getProviders().map(getStatusBarItem).filter(isStatusBarItem);
+};
+export const getStatusBarItemProviderRegistrySnapshot = () => {
+    return {
+        providers: registry.getProviders(),
+    };
+};
+export const resetStatusBarItemProviderRegistry = registry.reset;

package/extension-api/dist/parts/StatusBarItemProviderRegistrySnapshot/StatusBarItemProviderRegistrySnapshot.d.ts

@@ -0,0 +1,4 @@
+import type { RegisteredStatusBarItemProvider } from '../RegisteredStatusBarItemProvider/RegisteredStatusBarItemProvider.ts';
+export interface StatusBarItemProviderRegistrySnapshot {
+    readonly providers: readonly RegisteredStatusBarItemProvider[];
+}

package/extension-api/dist/parts/StatusBarItemProviderRegistrySnapshot/StatusBarItemProviderRegistrySnapshot.js

@@ -0,0 +1 @@
+export {};

package/extension-api/dist/parts/StatusBarItemProviderState/StatusBarItemProviderState.d.ts

@@ -0,0 +1 @@
+export { getStatusBarItemProviders, hasStatusBarItemProvider, resetStatusBarItemProviderRegistry as clearStatusBarItemProviders, } from '../StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.ts';

package/extension-api/dist/parts/StatusBarItemProviderState/StatusBarItemProviderState.js

@@ -0,0 +1 @@
+export { getStatusBarItemProviders, hasStatusBarItemProvider, resetStatusBarItemProviderRegistry as clearStatusBarItemProviders, } from "../StatusBarItemProviderRegistry/StatusBarItemProviderRegistry.js";

package/extension-api/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@lvce-editor/api",
+  "version": "8.18.0",
+  "description": "Tree-shakeable extension API for Lvce Editor extensions.",
+  "keywords": [
+    "lvce-editor",
+    "extension-api"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lvce-editor/extension-host-worker.git",
+    "directory": "packages/extension-api"
+  },
+  "license": "MIT",
+  "author": "Lvce Editor",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@lvce-editor/rpc": "^6.4.0"
+  }
+}