@lvce-editor/api 9.20.0 → 9.22.0

package/README.md

@@ -22,6 +22,14 @@ export const main = () => {
 
 The package is published as unbundled ESM with TypeScript declaration files, so extensions can bundle it with their own build tooling.
 
+Extensions running on Electron or a remote host can request the editor's user data directory as a `file:` URI. The call throws on the web platform.
+
+```ts
+import { getUserDataDir } from '@lvce-editor/api'
+
+const userDataDir = await getUserDataDir()
+```
+
 Electron extensions can create an off-screen web contents view. It stays hidden for the lifetime of the handle, and disposing the handle destroys its web contents.
 
 ```ts

package/dist/index.d.ts

@@ -18,7 +18,7 @@ export { executeFileSystemProviderGetPathSeparator, executeFileSystemProviderIsR
 export { closeUri, confirm, getRecentlyOpenedWorkspaceUris, 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';
+export { getPlatform, getUserDataDir, type Platform } from './parts/Platform/Platform.ts';
 export { focusNextTab, focusPreviousTab } from './parts/MainArea/MainArea.ts';
 export { openProcessExplorer } from './parts/ProcessExplorer/ProcessExplorer.ts';
 export { openDebugConsole, openOutputView, openProblemsView, type OpenDebugConsoleOptions, type OpenOutputViewOptions, type OpenProblemsViewOptions, } from './parts/Panel/Panel.ts';

package/dist/index.js

@@ -18,7 +18,7 @@ export { executeFileSystemProviderGetPathSeparator, executeFileSystemProviderIsR
 export { closeUri, confirm, getRecentlyOpenedWorkspaceUris, 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";
+export { getPlatform, getUserDataDir } from "./parts/Platform/Platform.js";
 export { focusNextTab, focusPreviousTab } from "./parts/MainArea/MainArea.js";
 export { openProcessExplorer } from "./parts/ProcessExplorer/ProcessExplorer.js";
 export { openDebugConsole, openOutputView, openProblemsView, } from "./parts/Panel/Panel.js";

package/dist/parts/ElectronWebContentsView/ElectronWebContentsView.d.ts

@@ -8,8 +8,9 @@ export interface ElectronWebContentsViewStats {
     readonly url: string;
 }
 export interface ElectronWebContentsView {
+    readonly click: (selector: string) => Promise<boolean>;
     readonly dispose: () => Promise<void>;
-    readonly executeJavaScript: <T = unknown>(code: string) => Promise<T>;
+    readonly executeJavaScript: <T = unknown>(code: string, userGesture?: boolean) => Promise<T>;
     readonly getStats: () => Promise<ElectronWebContentsViewStats>;
     readonly loadUrl: (url: string) => Promise<void>;
     readonly reload: () => Promise<void>;

package/dist/parts/ElectronWebContentsView/ElectronWebContentsView.js

@@ -38,6 +38,9 @@ export const createElectronWebContentsView = async ({ url } = {}) => {
         throw error;
     }
     return {
+        async click(selector) {
+            return (await rpc.invoke('ElectronWebContentsView.click', id, selector));
+        },
         async dispose() {
             if (disposed) {
                 return;
@@ -45,8 +48,8 @@ export const createElectronWebContentsView = async ({ url } = {}) => {
             disposed = true;
             await disposeAfterCreateError(rpc, id);
         },
-        async executeJavaScript(code) {
-            return (await rpc.invoke('ElectronWebContentsView.insertJavaScript', id, code));
+        async executeJavaScript(code, userGesture = false) {
+            return (await rpc.invoke('ElectronWebContentsView.insertJavaScript', id, code, userGesture));
         },
         async getStats() {
             return (await rpc.invoke('ElectronWebContentsView.getStats', id));

package/dist/parts/Platform/Platform.d.ts

@@ -1,2 +1,3 @@
 export type Platform = 'electron' | 'remote' | 'test' | 'web';
+export declare const getUserDataDir: () => Promise<string>;
 export declare const getPlatform: () => Promise<Platform>;

package/dist/parts/Platform/Platform.js

@@ -1,4 +1,7 @@
 import { executeCommand } from "../ExecuteCommand/ExecuteCommand.js";
+export const getUserDataDir = async () => {
+    return (await executeCommand('Platform.getUserDataDir'));
+};
 export const getPlatform = async () => {
     const platform = await executeCommand('Layout.getPlatform');
     switch (platform) {

package/package.json

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