@lvce-editor/api 9.18.1 → 9.20.0

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export { deleteSecret, getSecret, storeSecret } from './parts/SecretStorage/Secr
 export { registerCommand } from './parts/CommandRegistry/CommandRegistry.ts';
 export { registerDebugProvider, resetDebugProviderRegistry } from './parts/Debug/Debug.ts';
 export { formatDocument, getDiagnostics, getEditorSelections, setEditorSelections, showCompletions, type EditorSelection, } from './parts/Editor/Editor.ts';
+export { executeEditorLineDecorationProvider, registerEditorLineDecorationProvider, resetEditorLineDecorationProviderRegistry, type EditorLineDecoration, type EditorLineDecorationProvider, type EditorLineDecorationTextDocument, } from './parts/EditorLineDecorationApi/EditorLineDecorationApi.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';

package/dist/index.js

@@ -8,6 +8,7 @@ export { deleteSecret, getSecret, storeSecret } from "./parts/SecretStorage/Secr
 export { registerCommand } from "./parts/CommandRegistry/CommandRegistry.js";
 export { registerDebugProvider, resetDebugProviderRegistry } from "./parts/Debug/Debug.js";
 export { formatDocument, getDiagnostics, getEditorSelections, setEditorSelections, showCompletions, } from "./parts/Editor/Editor.js";
+export { executeEditorLineDecorationProvider, registerEditorLineDecorationProvider, resetEditorLineDecorationProviderRegistry, } from "./parts/EditorLineDecorationApi/EditorLineDecorationApi.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";

package/dist/parts/EditorLineDecoration/EditorLineDecoration.d.ts

@@ -0,0 +1,3 @@
+export interface EditorLineDecoration {
+    readonly text: string;
+}

package/dist/parts/EditorLineDecoration/EditorLineDecoration.js

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

package/dist/parts/EditorLineDecorationApi/EditorLineDecorationApi.d.ts

@@ -0,0 +1,4 @@
+export { executeEditorLineDecorationProvider, registerEditorLineDecorationProvider, resetEditorLineDecorationProviderRegistry, } from '../EditorLineDecorationProviderRegistry/EditorLineDecorationProviderRegistry.ts';
+export type { EditorLineDecoration } from '../EditorLineDecoration/EditorLineDecoration.ts';
+export type { EditorLineDecorationProvider } from '../EditorLineDecorationProvider/EditorLineDecorationProvider.ts';
+export type { EditorLineDecorationTextDocument } from '../EditorLineDecorationTextDocument/EditorLineDecorationTextDocument.ts';

package/dist/parts/EditorLineDecorationApi/EditorLineDecorationApi.js

@@ -0,0 +1 @@
+export { executeEditorLineDecorationProvider, registerEditorLineDecorationProvider, resetEditorLineDecorationProviderRegistry, } from "../EditorLineDecorationProviderRegistry/EditorLineDecorationProviderRegistry.js";

package/dist/parts/EditorLineDecorationProvider/EditorLineDecorationProvider.d.ts

@@ -0,0 +1,6 @@
+import type { EditorLineDecoration } from '../EditorLineDecoration/EditorLineDecoration.ts';
+import type { EditorLineDecorationTextDocument } from '../EditorLineDecorationTextDocument/EditorLineDecorationTextDocument.ts';
+export interface EditorLineDecorationProvider {
+    readonly id: string;
+    readonly provideEditorLineDecoration: (textDocument: EditorLineDecorationTextDocument, rowIndex: number) => EditorLineDecoration | undefined | Promise<EditorLineDecoration | undefined>;
+}

package/dist/parts/EditorLineDecorationProvider/EditorLineDecorationProvider.js

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

package/dist/parts/EditorLineDecorationProviderRegistry/EditorLineDecorationProviderRegistry.d.ts

@@ -0,0 +1,7 @@
+import type { Disposable } from '../Disposable/Disposable.ts';
+import type { EditorLineDecoration } from '../EditorLineDecoration/EditorLineDecoration.ts';
+import type { EditorLineDecorationProvider } from '../EditorLineDecorationProvider/EditorLineDecorationProvider.ts';
+import type { EditorLineDecorationTextDocument } from '../EditorLineDecorationTextDocument/EditorLineDecorationTextDocument.ts';
+export declare const registerEditorLineDecorationProvider: (provider: EditorLineDecorationProvider) => Disposable;
+export declare const executeEditorLineDecorationProvider: (textDocument: EditorLineDecorationTextDocument, rowIndex: number) => Promise<readonly EditorLineDecoration[]>;
+export declare const resetEditorLineDecorationProviderRegistry: () => void;

package/dist/parts/EditorLineDecorationProviderRegistry/EditorLineDecorationProviderRegistry.js

@@ -0,0 +1,45 @@
+import * as ExtensionApiCommandRegistry from "../ExtensionApiCommandRegistry/ExtensionApiCommandRegistry.js";
+import { ExtensionApiError } from "../ExtensionApiError/ExtensionApiError.js";
+import { createProviderRegistry } from "../ProviderRegistry/ProviderRegistry.js";
+const validateEditorLineDecoration = (decoration) => {
+    if (decoration === undefined) {
+        return undefined;
+    }
+    if (!decoration || typeof decoration !== 'object' || Array.isArray(decoration)) {
+        throw new ExtensionApiError('invalid editor line decoration result: decoration must be an object or undefined');
+    }
+    const { text } = decoration;
+    if (typeof text !== 'string') {
+        throw new ExtensionApiError('invalid editor line decoration result: decoration text must be a string');
+    }
+    return { text };
+};
+const registry = createProviderRegistry({
+    mapProvider(provider) {
+        return {
+            id: provider.id,
+            provideEditorLineDecoration(textDocument, rowIndex) {
+                return provider.provideEditorLineDecoration(textDocument, rowIndex);
+            },
+        };
+    },
+    providerName: 'editor line decoration provider',
+    requiredMethods: ['provideEditorLineDecoration'],
+});
+export const registerEditorLineDecorationProvider = (provider) => {
+    const registeredProvider = registry.registerProvider(provider);
+    ExtensionApiCommandRegistry.registerCommandMap(commandMap);
+    return {
+        dispose() {
+            registry.deleteProvider(registeredProvider.id);
+        },
+    };
+};
+export const executeEditorLineDecorationProvider = async (textDocument, rowIndex) => {
+    const results = await Promise.all(registry.getProviders().map(async (provider) => validateEditorLineDecoration(await provider.provideEditorLineDecoration(textDocument, rowIndex))));
+    return results.filter((result) => result !== undefined);
+};
+const commandMap = {
+    'ExtensionApi.executeEditorLineDecorationProvider': executeEditorLineDecorationProvider,
+};
+export const resetEditorLineDecorationProviderRegistry = registry.reset;

package/dist/parts/EditorLineDecorationTextDocument/EditorLineDecorationTextDocument.d.ts

@@ -0,0 +1,5 @@
+export interface EditorLineDecorationTextDocument {
+    readonly languageId: string;
+    readonly text: string;
+    readonly uri: string;
+}

package/dist/parts/EditorLineDecorationTextDocument/EditorLineDecorationTextDocument.js

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

package/dist/parts/RegisteredEditorLineDecorationProvider/RegisteredEditorLineDecorationProvider.d.ts

@@ -0,0 +1,6 @@
+import type { EditorLineDecoration } from '../EditorLineDecoration/EditorLineDecoration.ts';
+import type { EditorLineDecorationTextDocument } from '../EditorLineDecorationTextDocument/EditorLineDecorationTextDocument.ts';
+export interface RegisteredEditorLineDecorationProvider {
+    readonly id: string;
+    readonly provideEditorLineDecoration: (textDocument: EditorLineDecorationTextDocument, rowIndex: number) => EditorLineDecoration | undefined | Promise<EditorLineDecoration | undefined>;
+}

package/dist/parts/RegisteredEditorLineDecorationProvider/RegisteredEditorLineDecorationProvider.js

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

package/package.json

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