@lvce-editor/api 8.80.1 → 8.82.0

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { activate } from './parts/Activation/Activation.ts';
 export { getAccessToken, type GetAccessTokenOptions } from './parts/Authentication/Authentication.ts';
 export { createElectronWebContentsView } from './parts/ElectronWebContentsView/ElectronWebContentsView.ts';
 export { executeCommand } from './parts/ExecuteCommand/ExecuteCommand.ts';
-export { showQuickPick } from './parts/QuickPick/QuickPick.ts';
+export { showQuickInput, showQuickPick } from './parts/QuickPick/QuickPick.ts';
 export { getPreference, setPreference } from './parts/Preferences/Preferences.ts';
 export { deleteSecret, getSecret, storeSecret } from './parts/SecretStorage/SecretStorage.ts';
 export { registerCommand } from './parts/CommandRegistry/CommandRegistry.ts';
@@ -12,8 +12,8 @@ export { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot, regis
 export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, registerFormattingProvider, resetFormattingProviderRegistry, } from './parts/Formatting/Formatting.ts';
 export { exists, mkdir, readAsObjectUrl, readDirWithFileTypes, readFile, remove, stat, writeFile, type ReadAsObjectUrlResult, } from './parts/FileSystem/FileSystem.ts';
 export { registerFileChangeHandler, type FileChangeHandler, type FileChanges } from './parts/FileChangeHandler/FileChangeHandler.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 { executeFileSystemProviderGetPathSeparator, executeFileSystemProviderIsReadonly, executeFileSystemProviderMkdir, executeFileSystemProviderReadDirWithFileTypes, executeFileSystemProviderReadFile, executeFileSystemProviderRemove, executeFileSystemProviderRename, executeFileSystemProviderWriteFile, getFileSystemProviderRegistrySnapshot, registerFileSystemProvider, resetFileSystemProviderRegistry, } from './parts/FileSystemProviderRegistry/FileSystemProviderRegistry.ts';
+export { confirm, getWorkspaceFolder, getWorkspaceUri, handleWorkspaceRefresh, openUri, setWorkspaceUri, showNotification, type NotificationType, } from './parts/Host/Host.ts';
 export { executeHoverProvider, getHoverProviderRegistrySnapshot, registerHoverProvider, resetHoverProviderRegistry } from './parts/Hover/Hover.ts';
 export { executeSignatureHelpProvider, getSignatureHelpProviderRegistrySnapshot, registerSignatureHelpProvider, resetSignatureHelpProviderRegistry, } from './parts/SignatureHelp/SignatureHelp.ts';
 export { getPlatform, type Platform } from './parts/Platform/Platform.ts';
@@ -40,6 +40,7 @@ export type { FileSystemDirent } from './parts/FileSystem/FileSystem.ts';
 export type { FileSystemProvider } from './parts/FileSystemProvider/FileSystemProvider.ts';
 export type { FileSystemProviderRegistrySnapshot } from './parts/FileSystemProviderRegistrySnapshot/FileSystemProviderRegistrySnapshot.ts';
 export type { RegisteredFileSystemProvider } from './parts/RegisteredFileSystemProvider/RegisteredFileSystemProvider.ts';
+export type { ShowQuickInputOptions } from './parts/ShowQuickInputOptions/ShowQuickInputOptions.ts';
 export type { HandleExtensionManagementMessagePortOptions } from './parts/HandleExtensionManagementMessagePort/HandleExtensionManagementMessagePort.ts';
 export type { HoverProvider, HoverProviderRegistrySnapshot, HoverResult, RegisteredHoverProvider } from './parts/Hover/Hover.ts';
 export type { RegisteredSignatureHelpProvider, SignatureHelpParameter, SignatureHelpProvider, SignatureHelpProviderRegistrySnapshot, SignatureHelpResult, SignatureHelpSignature, } from './parts/SignatureHelp/SignatureHelp.ts';

package/dist/index.js

@@ -2,7 +2,7 @@ export { activate } from "./parts/Activation/Activation.js";
 export { getAccessToken } from "./parts/Authentication/Authentication.js";
 export { createElectronWebContentsView } from "./parts/ElectronWebContentsView/ElectronWebContentsView.js";
 export { executeCommand } from "./parts/ExecuteCommand/ExecuteCommand.js";
-export { showQuickPick } from "./parts/QuickPick/QuickPick.js";
+export { showQuickInput, showQuickPick } from "./parts/QuickPick/QuickPick.js";
 export { getPreference, setPreference } from "./parts/Preferences/Preferences.js";
 export { deleteSecret, getSecret, storeSecret } from "./parts/SecretStorage/SecretStorage.js";
 export { registerCommand } from "./parts/CommandRegistry/CommandRegistry.js";
@@ -12,8 +12,8 @@ export { executeDiagnosticProvider, getDiagnosticProviderRegistrySnapshot, regis
 export { executeFormattingProvider, getFormattingProviderRegistrySnapshot, registerFormattingProvider, resetFormattingProviderRegistry, } from "./parts/Formatting/Formatting.js";
 export { exists, mkdir, readAsObjectUrl, readDirWithFileTypes, readFile, remove, stat, writeFile, } from "./parts/FileSystem/FileSystem.js";
 export { registerFileChangeHandler } from "./parts/FileChangeHandler/FileChangeHandler.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 { executeFileSystemProviderGetPathSeparator, executeFileSystemProviderIsReadonly, executeFileSystemProviderMkdir, executeFileSystemProviderReadDirWithFileTypes, executeFileSystemProviderReadFile, executeFileSystemProviderRemove, executeFileSystemProviderRename, executeFileSystemProviderWriteFile, getFileSystemProviderRegistrySnapshot, registerFileSystemProvider, resetFileSystemProviderRegistry, } from "./parts/FileSystemProviderRegistry/FileSystemProviderRegistry.js";
+export { confirm, getWorkspaceFolder, getWorkspaceUri, handleWorkspaceRefresh, openUri, setWorkspaceUri, showNotification, } from "./parts/Host/Host.js";
 export { executeHoverProvider, getHoverProviderRegistrySnapshot, registerHoverProvider, resetHoverProviderRegistry } from "./parts/Hover/Hover.js";
 export { executeSignatureHelpProvider, getSignatureHelpProviderRegistrySnapshot, registerSignatureHelpProvider, resetSignatureHelpProviderRegistry, } from "./parts/SignatureHelp/SignatureHelp.js";
 export { getPlatform } from "./parts/Platform/Platform.js";

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

@@ -2,7 +2,11 @@ import type { FileSystemDirent } from '../FileSystemDirent/FileSystemDirent.ts';
 export interface FileSystemProvider {
     readonly id: string;
     readonly isReadonly?: () => boolean | Promise<boolean>;
+    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 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

@@ -3,8 +3,13 @@ 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 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>;
+export declare const executeFileSystemProviderWriteFile: (id: string, uri: string, content: string) => Promise<void>;
 export declare const executeFileSystemProviderReadDirWithFileTypes: (id: string, uri: string) => Promise<readonly FileSystemDirent[]>;
 export declare const executeFileSystemProviderGetPathSeparator: (id: string) => string;
+export declare const getFileSystemProviderPathSeparator: (id: string) => string | undefined;
 export declare const executeFileSystemProviderIsReadonly: (id: string) => Promise<boolean>;
 export declare const getFileSystemProviderRegistrySnapshot: () => FileSystemProviderRegistrySnapshot;
 export declare const registerFileSystemProvider: (provider: FileSystemProvider) => Disposable;

package/dist/parts/FileSystemProviderRegistry/FileSystemProviderRegistry.js

@@ -17,6 +17,11 @@ const assertFileSystemProvider = (provider) => {
     if (provider.isReadonly !== undefined && typeof provider.isReadonly !== 'function') {
         throw new ExtensionApiError(`file system provider ${provider.id} has invalid isReadonly function`);
     }
+    for (const method of ['mkdir', 'remove', 'rename', 'writeFile']) {
+        if (provider[method] !== undefined && typeof provider[method] !== 'function') {
+            throw new ExtensionApiError(`file system provider ${provider.id} has invalid ${method} function`);
+        }
+    }
     if (provider.pathSeparator !== undefined && typeof provider.pathSeparator !== 'string') {
         throw new ExtensionApiError(`file system provider ${provider.id} has invalid pathSeparator`);
     }
@@ -34,6 +39,34 @@ const getProvider = (id) => {
 export const executeFileSystemProviderReadFile = async (id, uri) => {
     return getProvider(id).readFile(uri);
 };
+export const executeFileSystemProviderMkdir = async (id, uri) => {
+    const provider = getProvider(id);
+    if (!provider.mkdir) {
+        throw new ExtensionApiError(`file system provider ${id} is missing mkdir function`);
+    }
+    await provider.mkdir(uri);
+};
+export const executeFileSystemProviderRemove = async (id, uri) => {
+    const provider = getProvider(id);
+    if (!provider.remove) {
+        throw new ExtensionApiError(`file system provider ${id} is missing remove function`);
+    }
+    await provider.remove(uri);
+};
+export const executeFileSystemProviderRename = async (id, oldUri, newUri) => {
+    const provider = getProvider(id);
+    if (!provider.rename) {
+        throw new ExtensionApiError(`file system provider ${id} is missing rename function`);
+    }
+    await provider.rename(oldUri, newUri);
+};
+export const executeFileSystemProviderWriteFile = async (id, uri, content) => {
+    const provider = getProvider(id);
+    if (!provider.writeFile) {
+        throw new ExtensionApiError(`file system provider ${id} is missing writeFile function`);
+    }
+    await provider.writeFile(uri, content);
+};
 export const executeFileSystemProviderReadDirWithFileTypes = async (id, uri) => {
     const provider = getProvider(id);
     if (!provider.readDirWithFileTypes) {
@@ -44,6 +77,13 @@ export const executeFileSystemProviderReadDirWithFileTypes = async (id, uri) =>
 export const executeFileSystemProviderGetPathSeparator = (id) => {
     return getProvider(id).pathSeparator || '/';
 };
+export const getFileSystemProviderPathSeparator = (id) => {
+    const provider = providers[id];
+    if (!provider) {
+        return undefined;
+    }
+    return provider.pathSeparator || '/';
+};
 export const executeFileSystemProviderIsReadonly = async (id) => {
     const provider = getProvider(id);
     return provider.isReadonly ? provider.isReadonly() : false;
@@ -60,9 +100,13 @@ export const registerFileSystemProvider = (provider) => {
     providers[provider.id] = {
         id: provider.id,
         isReadonly: provider.isReadonly,
+        mkdir: provider.mkdir,
         pathSeparator: provider.pathSeparator,
         readDirWithFileTypes: provider.readDirWithFileTypes,
         readFile: (uri) => provider.readFile(uri),
+        remove: provider.remove,
+        rename: provider.rename,
+        writeFile: provider.writeFile,
     };
     ExtensionApiCommandRegistry.registerCommandMap(commandMap);
     return {
@@ -74,8 +118,12 @@ export const registerFileSystemProvider = (provider) => {
 const commandMap = {
     'ExtensionApi.executeFileSystemProviderGetPathSeparator': executeFileSystemProviderGetPathSeparator,
     'ExtensionApi.executeFileSystemProviderIsReadonly': executeFileSystemProviderIsReadonly,
+    'ExtensionApi.executeFileSystemProviderMkdir': executeFileSystemProviderMkdir,
     'ExtensionApi.executeFileSystemProviderReadDirWithFileTypes': executeFileSystemProviderReadDirWithFileTypes,
     'ExtensionApi.executeFileSystemProviderReadFile': executeFileSystemProviderReadFile,
+    'ExtensionApi.executeFileSystemProviderRemove': executeFileSystemProviderRemove,
+    'ExtensionApi.executeFileSystemProviderRename': executeFileSystemProviderRename,
+    'ExtensionApi.executeFileSystemProviderWriteFile': executeFileSystemProviderWriteFile,
     'ExtensionApi.getFileSystemProviderRegistrySnapshot': getFileSystemProviderRegistrySnapshot,
 };
 export const resetFileSystemProviderRegistry = () => {

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

@@ -5,3 +5,4 @@ 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>;
+export declare const setWorkspaceUri: (uri: string) => Promise<void>;

package/dist/parts/Host/Host.js

@@ -1,4 +1,5 @@
 import { executeCommand } from "../ExecuteCommand/ExecuteCommand.js";
+import { getFileSystemProviderPathSeparator } from "../FileSystemProviderRegistry/FileSystemProviderRegistry.js";
 export const confirm = async (message) => {
     return Boolean(await executeCommand('ConfirmPrompt.prompt', message));
 };
@@ -17,3 +18,13 @@ export const openUri = async (uri) => {
 export const showNotification = async (type, message) => {
     await executeCommand('Notification.create', type, message);
 };
+export const setWorkspaceUri = async (uri) => {
+    const protocolEnd = uri.indexOf(':');
+    const protocol = protocolEnd === -1 ? '' : uri.slice(0, protocolEnd);
+    const pathSeparator = getFileSystemProviderPathSeparator(protocol);
+    if (pathSeparator === undefined) {
+        await executeCommand('Workspace.setUri', uri);
+        return;
+    }
+    await executeCommand('Workspace.setUri', uri, pathSeparator);
+};

package/dist/parts/QuickPick/QuickPick.d.ts

@@ -1,2 +1,4 @@
+import type { ShowQuickInputOptions } from '../ShowQuickInputOptions/ShowQuickInputOptions.ts';
 import type { ShowQuickPickOptions } from '../ShowQuickPickOptions/ShowQuickPickOptions.ts';
+export declare const showQuickInput: (options?: ShowQuickInputOptions) => Promise<string | undefined>;
 export declare const showQuickPick: (options: ShowQuickPickOptions) => Promise<unknown>;

package/dist/parts/QuickPick/QuickPick.js

@@ -1,4 +1,7 @@
 import { ExtensionManagementWorker } from '@lvce-editor/rpc-registry';
+export const showQuickInput = async (options = {}) => {
+    return ExtensionManagementWorker.invoke('ExtensionHostQuickPick.showQuickInput', options);
+};
 export const showQuickPick = async (options) => {
     return ExtensionManagementWorker.invoke('ExtensionHostQuickPick.showQuickPick', options);
 };

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

@@ -2,7 +2,11 @@ import type { FileSystemDirent } from '../FileSystemDirent/FileSystemDirent.ts';
 export interface RegisteredFileSystemProvider {
     readonly id: string;
     readonly isReadonly?: () => boolean | Promise<boolean>;
+    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 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/ShowQuickInputOptions/ShowQuickInputOptions.d.ts

@@ -0,0 +1,4 @@
+export interface ShowQuickInputOptions {
+    readonly placeholder?: string;
+    readonly value?: string;
+}

package/dist/parts/ShowQuickInputOptions/ShowQuickInputOptions.js

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

package/package.json

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