@lvce-editor/api 9.24.0 → 9.26.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 { executeEditorGutterDecorationProvider, refreshEditorGutterDecorations, registerEditorGutterDecorationProvider, resetEditorGutterDecorationProviderRegistry, type EditorGutterDecoration, type EditorGutterDecorationProvider, type EditorGutterDecorationTextDocument, type EditorGutterDecorationType, } from './parts/EditorGutterDecorationApi/EditorGutterDecorationApi.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';

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 { executeEditorGutterDecorationProvider, refreshEditorGutterDecorations, registerEditorGutterDecorationProvider, resetEditorGutterDecorationProviderRegistry, } from "./parts/EditorGutterDecorationApi/EditorGutterDecorationApi.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";

package/dist/parts/EditorGutterDecoration/EditorGutterDecoration.d.ts

@@ -0,0 +1,5 @@
+export type EditorGutterDecorationType = 'added' | 'deleted' | 'modified';
+export interface EditorGutterDecoration {
+    readonly rowIndex: number;
+    readonly type: EditorGutterDecorationType;
+}

package/dist/parts/EditorGutterDecoration/EditorGutterDecoration.js

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

package/dist/parts/EditorGutterDecorationApi/EditorGutterDecorationApi.d.ts

@@ -0,0 +1,5 @@
+export { executeEditorGutterDecorationProvider, registerEditorGutterDecorationProvider, resetEditorGutterDecorationProviderRegistry, } from '../EditorGutterDecorationProviderRegistry/EditorGutterDecorationProviderRegistry.ts';
+export type { EditorGutterDecoration, EditorGutterDecorationType } from '../EditorGutterDecoration/EditorGutterDecoration.ts';
+export type { EditorGutterDecorationProvider } from '../EditorGutterDecorationProvider/EditorGutterDecorationProvider.ts';
+export type { EditorGutterDecorationTextDocument } from '../EditorGutterDecorationTextDocument/EditorGutterDecorationTextDocument.ts';
+export { refreshEditorGutterDecorations } from '../RefreshEditorGutterDecorations/RefreshEditorGutterDecorations.ts';

package/dist/parts/EditorGutterDecorationApi/EditorGutterDecorationApi.js

@@ -0,0 +1,2 @@
+export { executeEditorGutterDecorationProvider, registerEditorGutterDecorationProvider, resetEditorGutterDecorationProviderRegistry, } from "../EditorGutterDecorationProviderRegistry/EditorGutterDecorationProviderRegistry.js";
+export { refreshEditorGutterDecorations } from "../RefreshEditorGutterDecorations/RefreshEditorGutterDecorations.js";

package/dist/parts/EditorGutterDecorationProvider/EditorGutterDecorationProvider.d.ts

@@ -0,0 +1,6 @@
+import type { EditorGutterDecoration } from '../EditorGutterDecoration/EditorGutterDecoration.ts';
+import type { EditorGutterDecorationTextDocument } from '../EditorGutterDecorationTextDocument/EditorGutterDecorationTextDocument.ts';
+export interface EditorGutterDecorationProvider {
+    readonly id: string;
+    readonly provideEditorGutterDecorations: (textDocument: EditorGutterDecorationTextDocument) => readonly EditorGutterDecoration[] | Promise<readonly EditorGutterDecoration[]>;
+}

package/dist/parts/EditorGutterDecorationProvider/EditorGutterDecorationProvider.js

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

package/dist/parts/EditorGutterDecorationProviderRegistry/EditorGutterDecorationProviderRegistry.d.ts

@@ -0,0 +1,7 @@
+import type { Disposable } from '../Disposable/Disposable.ts';
+import type { EditorGutterDecoration } from '../EditorGutterDecoration/EditorGutterDecoration.ts';
+import type { EditorGutterDecorationProvider } from '../EditorGutterDecorationProvider/EditorGutterDecorationProvider.ts';
+import type { EditorGutterDecorationTextDocument } from '../EditorGutterDecorationTextDocument/EditorGutterDecorationTextDocument.ts';
+export declare const registerEditorGutterDecorationProvider: (provider: EditorGutterDecorationProvider) => Disposable;
+export declare const executeEditorGutterDecorationProvider: (textDocument: EditorGutterDecorationTextDocument) => Promise<readonly EditorGutterDecoration[]>;
+export declare const resetEditorGutterDecorationProviderRegistry: () => void;

package/dist/parts/EditorGutterDecorationProviderRegistry/EditorGutterDecorationProviderRegistry.js

@@ -0,0 +1,52 @@
+import * as ExtensionApiCommandRegistry from "../ExtensionApiCommandRegistry/ExtensionApiCommandRegistry.js";
+import { ExtensionApiError } from "../ExtensionApiError/ExtensionApiError.js";
+import { createProviderRegistry } from "../ProviderRegistry/ProviderRegistry.js";
+const validTypes = new Set(['added', 'deleted', 'modified']);
+const validateEditorGutterDecoration = (decoration) => {
+    if (!decoration || typeof decoration !== 'object' || Array.isArray(decoration)) {
+        throw new ExtensionApiError('invalid editor gutter decoration result: decoration must be an object');
+    }
+    const { rowIndex, type } = decoration;
+    if (!Number.isSafeInteger(rowIndex) || rowIndex < 0) {
+        throw new ExtensionApiError('invalid editor gutter decoration result: decoration rowIndex must be a non-negative integer');
+    }
+    if (typeof type !== 'string' || !validTypes.has(type)) {
+        throw new ExtensionApiError('invalid editor gutter decoration result: decoration type must be added, deleted, or modified');
+    }
+    return { rowIndex: rowIndex, type: type };
+};
+const validateEditorGutterDecorations = (decorations) => {
+    if (!Array.isArray(decorations)) {
+        throw new ExtensionApiError('invalid editor gutter decoration result: decorations must be an array');
+    }
+    return decorations.map(validateEditorGutterDecoration);
+};
+const registry = createProviderRegistry({
+    mapProvider(provider) {
+        return {
+            id: provider.id,
+            provideEditorGutterDecorations(textDocument) {
+                return provider.provideEditorGutterDecorations(textDocument);
+            },
+        };
+    },
+    providerName: 'editor gutter decoration provider',
+    requiredMethods: ['provideEditorGutterDecorations'],
+});
+export const registerEditorGutterDecorationProvider = (provider) => {
+    const registeredProvider = registry.registerProvider(provider);
+    ExtensionApiCommandRegistry.registerCommandMap(commandMap);
+    return {
+        dispose() {
+            registry.deleteProvider(registeredProvider.id);
+        },
+    };
+};
+export const executeEditorGutterDecorationProvider = async (textDocument) => {
+    const results = await Promise.all(registry.getProviders().map(async (provider) => provider.provideEditorGutterDecorations(textDocument)));
+    return results.flatMap(validateEditorGutterDecorations);
+};
+const commandMap = {
+    'ExtensionApi.executeEditorGutterDecorationProvider': executeEditorGutterDecorationProvider,
+};
+export const resetEditorGutterDecorationProviderRegistry = registry.reset;

package/dist/parts/EditorGutterDecorationTextDocument/EditorGutterDecorationTextDocument.d.ts

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

package/dist/parts/EditorGutterDecorationTextDocument/EditorGutterDecorationTextDocument.js

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

package/dist/parts/FileSystemProvider/FileSystemProvider.d.ts

@@ -5,7 +5,7 @@ export interface FileSystemProvider {
     readonly mkdir?: (uri: string) => void | Promise<void>;
     readonly pathSeparator?: string;
     readonly readDirWithFileTypes?: (uri: string) => readonly FileSystemDirent[] | Promise<readonly FileSystemDirent[]>;
-    readonly readFile: (uri: string) => string | Promise<string>;
+    readonly readFile: (uri: string) => Blob | Promise<Blob | string> | string;
     readonly remove?: (uri: string) => void | Promise<void>;
     readonly rename?: (oldUri: string, newUri: string) => void | Promise<void>;
     readonly writeFile?: (uri: string, content: string) => void | Promise<void>;

package/dist/parts/FileSystemProviderRegistry/FileSystemProviderRegistry.d.ts

@@ -2,7 +2,7 @@ import type { Disposable } from '../Disposable/Disposable.ts';
 import type { FileSystemDirent } from '../FileSystemDirent/FileSystemDirent.ts';
 import type { FileSystemProvider } from '../FileSystemProvider/FileSystemProvider.ts';
 import type { FileSystemProviderRegistrySnapshot } from '../FileSystemProviderRegistrySnapshot/FileSystemProviderRegistrySnapshot.ts';
-export declare const executeFileSystemProviderReadFile: (id: string, uri: string) => Promise<string>;
+export declare const executeFileSystemProviderReadFile: (id: string, uri: string) => Promise<Blob | string>;
 export declare const executeFileSystemProviderMkdir: (id: string, uri: string) => Promise<void>;
 export declare const executeFileSystemProviderRemove: (id: string, uri: string) => Promise<void>;
 export declare const executeFileSystemProviderRename: (id: string, oldUri: string, newUri: string) => Promise<void>;

package/dist/parts/RefreshEditorGutterDecorations/RefreshEditorGutterDecorations.d.ts

@@ -0,0 +1 @@
+export declare const refreshEditorGutterDecorations: () => Promise<void>;

package/dist/parts/RefreshEditorGutterDecorations/RefreshEditorGutterDecorations.js

@@ -0,0 +1,4 @@
+import { executeCommand } from "../ExecuteCommand/ExecuteCommand.js";
+export const refreshEditorGutterDecorations = async () => {
+    await executeCommand('Editor.refreshGutterDecorationsAll');
+};

package/dist/parts/RegisteredEditorGutterDecorationProvider/RegisteredEditorGutterDecorationProvider.d.ts

@@ -0,0 +1,6 @@
+import type { EditorGutterDecoration } from '../EditorGutterDecoration/EditorGutterDecoration.ts';
+import type { EditorGutterDecorationTextDocument } from '../EditorGutterDecorationTextDocument/EditorGutterDecorationTextDocument.ts';
+export interface RegisteredEditorGutterDecorationProvider {
+    readonly id: string;
+    readonly provideEditorGutterDecorations: (textDocument: EditorGutterDecorationTextDocument) => readonly EditorGutterDecoration[] | Promise<readonly EditorGutterDecoration[]>;
+}

package/dist/parts/RegisteredEditorGutterDecorationProvider/RegisteredEditorGutterDecorationProvider.js

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

package/dist/parts/RegisteredFileSystemProvider/RegisteredFileSystemProvider.d.ts

@@ -5,7 +5,7 @@ export interface RegisteredFileSystemProvider {
     readonly mkdir?: (uri: string) => void | Promise<void>;
     readonly pathSeparator?: string;
     readonly readDirWithFileTypes?: (uri: string) => readonly FileSystemDirent[] | Promise<readonly FileSystemDirent[]>;
-    readonly readFile: (uri: string) => string | Promise<string>;
+    readonly readFile: (uri: string) => Blob | Promise<Blob | string> | string;
     readonly remove?: (uri: string) => void | Promise<void>;
     readonly rename?: (oldUri: string, newUri: string) => void | Promise<void>;
     readonly writeFile?: (uri: string, content: string) => void | Promise<void>;

package/dist/parts/WebRtc/WebRtc.d.ts

@@ -1,4 +1,5 @@
 export interface StartWebRpcAudioStreamOptions {
+    readonly audioDebugPort?: MessagePort;
     readonly elementLocator: string;
     readonly ephemeralKey: string;
     readonly port: MessagePort;

package/package.json

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