@lvce-editor/api 8.67.0 → 8.69.0

package/README.md

@@ -31,3 +31,13 @@ const view = await createElectronWebContentsView({ url: 'https://example.com' })
 const title = await view.executeJavaScript<string>('document.title')
 await view.dispose()
 ```
+
+Extensions can persist sensitive strings without depending on the editor's browser cache. Values are scoped to the calling extension.
+
+```ts
+import { deleteSecret, getSecret, storeSecret } from '@lvce-editor/api'
+
+await storeSecret('access-token', token)
+const savedToken = await getSecret('access-token')
+await deleteSecret('access-token')
+```

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { createElectronWebContentsView } from './parts/ElectronWebContentsView/E
 export { executeCommand } from './parts/ExecuteCommand/ExecuteCommand.ts';
 export { 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';
 export { registerDebugProvider, resetDebugProviderRegistry } from './parts/Debug/Debug.ts';
 export { executeCompletionProvider, executeResolveCompletionItemProvider, getCompletionProviderRegistrySnapshot, registerCompletionProvider, resetCompletionProviderRegistry, } from './parts/Completion/Completion.ts';
@@ -21,7 +22,7 @@ export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSource
 export { createViewInstance, dispatchViewEvent, disposeViewInstance, executeViewProvider, getViewRegistrySnapshot, renderViewInstance, registerView, resetViewRegistry, saveViewInstanceState, } from './parts/ViewRegistry/ViewRegistry.ts';
 export { createOutputChannel, getOutputChannelRegistrySnapshot, resetOutputChannelRegistry } from './parts/OutputChannel/OutputChannel.ts';
 export { getStatusBarItemProviderRegistrySnapshot, registerStatusBarItemProvider, resetStatusBarItemProviderRegistry, } from './parts/StatusBar/StatusBar.ts';
-export type { RegisteredView, View, ViewAction, ViewCommand, ViewContext, ViewEvent, ViewKind, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, ViewScrollPosition, ViewSelection, VirtualDomViewInstance, } from './parts/View/View.ts';
+export type { RegisteredView, View, ViewAction, ViewCommand, ViewContext, ViewEvent, ViewKind, ViewPreferredLocation, MenuEntry, ViewRegistrySnapshot, ViewRenderResult, ViewScrollPosition, ViewSelection, VirtualDomViewInstance, } from './parts/View/View.ts';
 export { handleExtensionManagementMessagePort } from './parts/HandleExtensionManagementMessagePort/HandleExtensionManagementMessagePort.ts';
 export { createNodeRpc, createRpc } from './parts/Rpc/Rpc.ts';
 export type { Command } from './parts/Command/Command.ts';

package/dist/index.js

@@ -4,6 +4,7 @@ export { createElectronWebContentsView } from "./parts/ElectronWebContentsView/E
 export { executeCommand } from "./parts/ExecuteCommand/ExecuteCommand.js";
 export { 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";
 export { registerDebugProvider, resetDebugProviderRegistry } from "./parts/Debug/Debug.js";
 export { executeCompletionProvider, executeResolveCompletionItemProvider, getCompletionProviderRegistrySnapshot, registerCompletionProvider, resetCompletionProviderRegistry, } from "./parts/Completion/Completion.js";

package/dist/parts/SecretStorage/SecretStorage.d.ts

@@ -0,0 +1,3 @@
+export declare const deleteSecret: (key: string) => Promise<void>;
+export declare const getSecret: (key: string) => Promise<string | undefined>;
+export declare const storeSecret: (key: string, value: string) => Promise<void>;

package/dist/parts/SecretStorage/SecretStorage.js

@@ -0,0 +1,10 @@
+import { ExtensionManagementWorker } from '@lvce-editor/rpc-registry';
+export const deleteSecret = async (key) => {
+    await ExtensionManagementWorker.invoke('Extensions.deleteSecret', key);
+};
+export const getSecret = async (key) => {
+    return ExtensionManagementWorker.invoke('Extensions.getSecret', key);
+};
+export const storeSecret = async (key, value) => {
+    await ExtensionManagementWorker.invoke('Extensions.storeSecret', key, value);
+};

package/dist/parts/View/View.d.ts

@@ -1,5 +1,6 @@
 import type { VirtualDomNode } from '@lvce-editor/virtual-dom-worker';
 export type ViewKind = 'virtualDom';
+export type ViewPreferredLocation = 'preview' | 'sideBar';
 export interface ViewContext {
     readonly requestRerender: () => Promise<void>;
     readonly showContextMenu: (menuId: string, x: number, y: number) => Promise<void>;
@@ -68,6 +69,7 @@ export interface View<State = unknown> {
     readonly id: string;
     readonly kind?: ViewKind;
     readonly name?: string;
+    readonly preferredLocation?: ViewPreferredLocation;
     readonly title?: string;
 }
 export interface RegisteredView {
@@ -77,6 +79,7 @@ export interface RegisteredView {
     readonly id: string;
     readonly kind?: ViewKind;
     readonly name?: string;
+    readonly preferredLocation: ViewPreferredLocation;
     readonly title?: string;
 }
 export interface ViewRegistrySnapshot {

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -86,6 +86,9 @@ const assertView = (view) => {
     if (view.id in views) {
         throw new ExtensionApiError(`view ${view.id} is already registered`);
     }
+    if (view.preferredLocation !== undefined && view.preferredLocation !== 'preview' && view.preferredLocation !== 'sideBar') {
+        throw new ExtensionApiError(`view ${view.id} has invalid preferredLocation`);
+    }
     assertCommands(view);
     assertEventListeners(view);
 };
@@ -97,6 +100,7 @@ const toRegisteredView = (view) => {
         icon: view.icon,
         id: view.id,
         name: view.name,
+        preferredLocation: view.preferredLocation || 'sideBar',
         title: displayName,
     };
     if (view.kind) {

package/package.json

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