@lvce-editor/api 8.61.0 → 8.63.0

package/dist/index.d.ts

@@ -9,8 +9,8 @@ export { executeCompletionProvider, executeResolveCompletionItemProvider, getCom
 export { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot, registerDiagnosticProvider, resetDiagnosticProviderRegistry, } from './parts/Diagnostic/Diagnostic.ts';
 export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, registerFormattingProvider, resetFormattingProviderRegistry, } from './parts/Formatting/Formatting.ts';
 export { exists, mkdir, readDirWithFileTypes, readFile, remove, stat, writeFile } from './parts/FileSystem/FileSystem.ts';
-export { executeFileSystemProviderReadFile, getFileSystemProviderRegistrySnapshot, registerFileSystemProvider, resetFileSystemProviderRegistry, } from './parts/FileSystemProviderRegistry/FileSystemProviderRegistry.ts';
-export { confirm, getWorkspaceFolder, getWorkspaceUri, handleWorkspaceRefresh, openUri } from './parts/Host/Host.ts';
+export { executeFileSystemProviderGetPathSeparator, executeFileSystemProviderIsReadonly, executeFileSystemProviderReadDirWithFileTypes, executeFileSystemProviderReadFile, getFileSystemProviderRegistrySnapshot, registerFileSystemProvider, resetFileSystemProviderRegistry, } from './parts/FileSystemProviderRegistry/FileSystemProviderRegistry.ts';
+export { confirm, getWorkspaceFolder, getWorkspaceUri, handleWorkspaceRefresh, openUri, showNotification, type NotificationType, } from './parts/Host/Host.ts';
 export { executeHoverProvider, getHoverProviderRegistrySnapshot, registerHoverProvider, resetHoverProviderRegistry } from './parts/Hover/Hover.ts';
 export { getPlatform, type Platform } from './parts/Platform/Platform.ts';
 export { getLanguageServerRegistrySnapshot, registerLanguageServer, resetLanguageServerRegistry } from './parts/LanguageServer/LanguageServer.ts';

package/dist/index.js

@@ -9,8 +9,8 @@ export { executeCompletionProvider, executeResolveCompletionItemProvider, getCom
 export { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot, registerDiagnosticProvider, resetDiagnosticProviderRegistry, } from "./parts/Diagnostic/Diagnostic.js";
 export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, registerFormattingProvider, resetFormattingProviderRegistry, } from "./parts/Formatting/Formatting.js";
 export { exists, mkdir, readDirWithFileTypes, readFile, remove, stat, writeFile } from "./parts/FileSystem/FileSystem.js";
-export { executeFileSystemProviderReadFile, getFileSystemProviderRegistrySnapshot, registerFileSystemProvider, resetFileSystemProviderRegistry, } from "./parts/FileSystemProviderRegistry/FileSystemProviderRegistry.js";
-export { confirm, getWorkspaceFolder, getWorkspaceUri, handleWorkspaceRefresh, openUri } from "./parts/Host/Host.js";
+export { executeFileSystemProviderGetPathSeparator, executeFileSystemProviderIsReadonly, executeFileSystemProviderReadDirWithFileTypes, executeFileSystemProviderReadFile, getFileSystemProviderRegistrySnapshot, registerFileSystemProvider, resetFileSystemProviderRegistry, } from "./parts/FileSystemProviderRegistry/FileSystemProviderRegistry.js";
+export { confirm, getWorkspaceFolder, getWorkspaceUri, handleWorkspaceRefresh, openUri, showNotification, } from "./parts/Host/Host.js";
 export { executeHoverProvider, getHoverProviderRegistrySnapshot, registerHoverProvider, resetHoverProviderRegistry } from "./parts/Hover/Hover.js";
 export { getPlatform } from "./parts/Platform/Platform.js";
 export { getLanguageServerRegistrySnapshot, registerLanguageServer, resetLanguageServerRegistry } from "./parts/LanguageServer/LanguageServer.js";

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

@@ -6,6 +6,9 @@ export declare const commandMap: {
     'ExtensionApi.executeCommand': (id: string, ...args: readonly unknown[]) => Promise<unknown>;
     'ExtensionApi.executeCompletionProvider': (textDocument: import("../CompletionTextDocument/CompletionTextDocument.ts").TextDocument, offset: number, ...args: readonly unknown[]) => Promise<readonly import("../CompletionItem/CompletionItem.ts").CompletionItem[]>;
     'ExtensionApi.executeDiagnosticProvider': (textDocument: import("../DiagnosticTextDocument/DiagnosticTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../DiagnosticResult/DiagnosticResult.ts").Diagnostic[]>;
+    'ExtensionApi.executeFileSystemProviderGetPathSeparator': (id: string) => string;
+    'ExtensionApi.executeFileSystemProviderIsReadonly': (id: string) => Promise<boolean>;
+    'ExtensionApi.executeFileSystemProviderReadDirWithFileTypes': (id: string, uri: string) => Promise<readonly import("../FileSystemDirent/FileSystemDirent.ts").FileSystemDirent[]>;
     'ExtensionApi.executeFileSystemProviderReadFile': (id: string, uri: string) => Promise<string>;
     '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>;

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

@@ -5,6 +5,9 @@ export declare const commandMap: {
     'ExtensionApi.executeCommand': (id: string, ...args: readonly unknown[]) => Promise<unknown>;
     'ExtensionApi.executeCompletionProvider': (textDocument: import("../CompletionTextDocument/CompletionTextDocument.ts").TextDocument, offset: number, ...args: readonly unknown[]) => Promise<readonly import("../CompletionItem/CompletionItem.ts").CompletionItem[]>;
     'ExtensionApi.executeDiagnosticProvider': (textDocument: import("../DiagnosticTextDocument/DiagnosticTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../DiagnosticResult/DiagnosticResult.ts").Diagnostic[]>;
+    'ExtensionApi.executeFileSystemProviderGetPathSeparator': (id: string) => string;
+    'ExtensionApi.executeFileSystemProviderIsReadonly': (id: string) => Promise<boolean>;
+    'ExtensionApi.executeFileSystemProviderReadDirWithFileTypes': (id: string, uri: string) => Promise<readonly import("../FileSystemDirent/FileSystemDirent.ts").FileSystemDirent[]>;
     'ExtensionApi.executeFileSystemProviderReadFile': (id: string, uri: string) => Promise<string>;
     '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>;

package/dist/parts/ExtensionApiCommandMap/ExtensionApiCommandMap.js

@@ -1,7 +1,7 @@
 import { executeCommand, getCommandRegistrySnapshot } from "../CommandRegistry/CommandRegistry.js";
 import { executeCompletionProvider, executeResolveCompletionItemProvider, getCompletionProviderRegistrySnapshot } from "../Completion/Completion.js";
 import { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot } from "../Diagnostic/Diagnostic.js";
-import { executeFileSystemProviderReadFile, getFileSystemProviderRegistrySnapshot } from "../FileSystemProviderRegistry/FileSystemProviderRegistry.js";
+import { executeFileSystemProviderGetPathSeparator, executeFileSystemProviderIsReadonly, executeFileSystemProviderReadDirWithFileTypes, executeFileSystemProviderReadFile, getFileSystemProviderRegistrySnapshot, } from "../FileSystemProviderRegistry/FileSystemProviderRegistry.js";
 import { executeFormattingProvider, getFormattingProviderRegistrySnapshot } from "../Formatting/Formatting.js";
 import { getStatusBarItems } from "../GetStatusBarItems/GetStatusBarItems.js";
 import { executeHoverProvider, getHoverProviderRegistrySnapshot } from "../Hover/Hover.js";
@@ -17,6 +17,9 @@ export const commandMap = {
     'ExtensionApi.executeCommand': executeCommand,
     'ExtensionApi.executeCompletionProvider': executeCompletionProvider,
     'ExtensionApi.executeDiagnosticProvider': executeDiagnosticProvider,
+    'ExtensionApi.executeFileSystemProviderGetPathSeparator': executeFileSystemProviderGetPathSeparator,
+    'ExtensionApi.executeFileSystemProviderIsReadonly': executeFileSystemProviderIsReadonly,
+    'ExtensionApi.executeFileSystemProviderReadDirWithFileTypes': executeFileSystemProviderReadDirWithFileTypes,
     'ExtensionApi.executeFileSystemProviderReadFile': executeFileSystemProviderReadFile,
     'ExtensionApi.executeFormattingProvider': executeFormattingProvider,
     'ExtensionApi.executeHoverProvider': executeHoverProvider,

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

@@ -7,6 +7,9 @@ export declare const commandMap: {
     'ExtensionApi.executeCommand': (id: string, ...args: readonly unknown[]) => Promise<unknown>;
     'ExtensionApi.executeCompletionProvider': (textDocument: import("../CompletionTextDocument/CompletionTextDocument.ts").TextDocument, offset: number, ...args: readonly unknown[]) => Promise<readonly import("../CompletionItem/CompletionItem.ts").CompletionItem[]>;
     'ExtensionApi.executeDiagnosticProvider': (textDocument: import("../DiagnosticTextDocument/DiagnosticTextDocument.ts").TextDocument, ...args: readonly unknown[]) => Promise<readonly import("../DiagnosticResult/DiagnosticResult.ts").Diagnostic[]>;
+    'ExtensionApi.executeFileSystemProviderGetPathSeparator': (id: string) => string;
+    'ExtensionApi.executeFileSystemProviderIsReadonly': (id: string) => Promise<boolean>;
+    'ExtensionApi.executeFileSystemProviderReadDirWithFileTypes': (id: string, uri: string) => Promise<readonly import("../FileSystemDirent/FileSystemDirent.ts").FileSystemDirent[]>;
     'ExtensionApi.executeFileSystemProviderReadFile': (id: string, uri: string) => Promise<string>;
     '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>;

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

@@ -1,4 +1,8 @@
+import type { FileSystemDirent } from '../FileSystemDirent/FileSystemDirent.ts';
 export interface FileSystemProvider {
     readonly id: string;
+    readonly isReadonly?: () => boolean | Promise<boolean>;
+    readonly pathSeparator?: string;
+    readonly readDirWithFileTypes?: (uri: string) => readonly FileSystemDirent[] | Promise<readonly FileSystemDirent[]>;
     readonly readFile: (uri: string) => string | Promise<string>;
 }

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

@@ -1,7 +1,11 @@
 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 executeFileSystemProviderReadDirWithFileTypes: (id: string, uri: string) => Promise<readonly FileSystemDirent[]>;
+export declare const executeFileSystemProviderGetPathSeparator: (id: string) => string;
+export declare const executeFileSystemProviderIsReadonly: (id: string) => Promise<boolean>;
 export declare const getFileSystemProviderRegistrySnapshot: () => FileSystemProviderRegistrySnapshot;
 export declare const registerFileSystemProvider: (provider: FileSystemProvider) => Disposable;
 export declare const resetFileSystemProviderRegistry: () => void;

package/dist/parts/FileSystemProviderRegistry/FileSystemProviderRegistry.js

@@ -10,6 +10,15 @@ const assertFileSystemProvider = (provider) => {
     if (typeof provider.readFile !== 'function') {
         throw new ExtensionApiError(`file system provider ${provider.id} is missing readFile function`);
     }
+    if (provider.readDirWithFileTypes !== undefined && typeof provider.readDirWithFileTypes !== 'function') {
+        throw new ExtensionApiError(`file system provider ${provider.id} has invalid readDirWithFileTypes function`);
+    }
+    if (provider.isReadonly !== undefined && typeof provider.isReadonly !== 'function') {
+        throw new ExtensionApiError(`file system provider ${provider.id} has invalid isReadonly function`);
+    }
+    if (provider.pathSeparator !== undefined && typeof provider.pathSeparator !== 'string') {
+        throw new ExtensionApiError(`file system provider ${provider.id} has invalid pathSeparator`);
+    }
     if (provider.id in providers) {
         throw new ExtensionApiError(`file system provider ${provider.id} is already registered`);
     }
@@ -24,6 +33,20 @@ const getProvider = (id) => {
 export const executeFileSystemProviderReadFile = async (id, uri) => {
     return getProvider(id).readFile(uri);
 };
+export const executeFileSystemProviderReadDirWithFileTypes = async (id, uri) => {
+    const provider = getProvider(id);
+    if (!provider.readDirWithFileTypes) {
+        throw new ExtensionApiError(`file system provider ${id} is missing readDirWithFileTypes function`);
+    }
+    return provider.readDirWithFileTypes(uri);
+};
+export const executeFileSystemProviderGetPathSeparator = (id) => {
+    return getProvider(id).pathSeparator || '/';
+};
+export const executeFileSystemProviderIsReadonly = async (id) => {
+    const provider = getProvider(id);
+    return provider.isReadonly ? provider.isReadonly() : false;
+};
 export const getFileSystemProviderRegistrySnapshot = () => {
     return {
         providers: Object.values(providers).map((provider) => ({
@@ -35,6 +58,9 @@ export const registerFileSystemProvider = (provider) => {
     assertFileSystemProvider(provider);
     providers[provider.id] = {
         id: provider.id,
+        isReadonly: provider.isReadonly,
+        pathSeparator: provider.pathSeparator,
+        readDirWithFileTypes: provider.readDirWithFileTypes,
         readFile: (uri) => provider.readFile(uri),
     };
     return {

package/dist/parts/Host/Host.d.ts

@@ -1,5 +1,7 @@
+export type NotificationType = 'error' | 'info' | 'warning';
 export declare const confirm: (message: string) => Promise<boolean>;
 export declare const getWorkspaceFolder: () => Promise<string>;
 export declare const getWorkspaceUri: () => Promise<string>;
 export declare const handleWorkspaceRefresh: () => Promise<void>;
 export declare const openUri: (uri: string) => Promise<void>;
+export declare const showNotification: (type: NotificationType, message: string) => Promise<void>;

package/dist/parts/Host/Host.js

@@ -14,3 +14,6 @@ export const handleWorkspaceRefresh = async () => {
 export const openUri = async (uri) => {
     await executeCommand('Main.openUri', uri);
 };
+export const showNotification = async (type, message) => {
+    await executeCommand('Notification.create', type, message);
+};

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

@@ -1,4 +1,8 @@
+import type { FileSystemDirent } from '../FileSystemDirent/FileSystemDirent.ts';
 export interface RegisteredFileSystemProvider {
     readonly id: string;
+    readonly isReadonly?: () => boolean | Promise<boolean>;
+    readonly pathSeparator?: string;
+    readonly readDirWithFileTypes?: (uri: string) => readonly FileSystemDirent[] | Promise<readonly FileSystemDirent[]>;
     readonly readFile: (uri: string) => string | Promise<string>;
 }

package/package.json

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