Class BrowserOnlyPluginServer

Plugins of a browser-only application are deployed at build time, so they can't be installed, uninstalled, enabled or disabled at runtime. The queries just report an empty result instead of failing, so callers like the plugin view still have something to render.

The plugin key-value storage backing ExtensionContext.globalState and ExtensionContext.workspaceState lives in the browser's local storage.

Implements

PluginServer

Constructors

constructor

new BrowserOnlyPluginServer(): BrowserOnlyPluginServer
Returns BrowserOnlyPluginServer

Properties

`Protected` `Readonly`localLock

localLock: Mutex = ...

Fallback for withStoreLock when the Web Locks API is unavailable.

`Protected` `Readonly`logger

logger: ILogger

`Protected`missingLocksWarned

missingLocksWarned: boolean = false

`Protected` `Readonly`pluginPathsService

pluginPathsService: PluginPathsService

`Protected` `Readonly`storageService

storageService: StorageService

@theia/workspace rebinds StorageService to WorkspaceStorageService, which prefixes every key with the current workspace URI. That would scope GLOBAL_STORAGE_KEY per workspace too, so LocalStorageService is injected directly instead - the workspace store key already encodes the workspace via PluginPathsService.getHostStoragePath.

Methods

disablePlugin

disablePlugin(pluginId: `${string}.${string}`): Promise<boolean>
Parameters
- pluginId: `${string}.${string}`
Returns Promise<boolean>
Implementation of PluginServer.disablePlugin
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:69

enablePlugin

enablePlugin(pluginId: `${string}.${string}`): Promise<boolean>
Parameters
- pluginId: `${string}.${string}`
Returns Promise<boolean>
Implementation of PluginServer.enablePlugin
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:65

getAllStorageValues

getAllStorageValues(kind: PluginStorageKind): Promise<KeysToKeysToAnyValue>
Parameters
- kind: PluginStorageKind
Returns Promise<KeysToKeysToAnyValue>
Implementation of PluginServer.getAllStorageValues
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:110

getDisabledPlugins

getDisabledPlugins(): Promise<readonly `${string}.${string}`[]>
Returns Promise<readonly `${string}.${string}`[]>
Implementation of PluginServer.getDisabledPlugins
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:81

getInstalledPlugins

getInstalledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
Implementation of PluginServer.getInstalledPlugins
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:73

getStorageValue

getStorageValue(key: string, kind: PluginStorageKind): Promise<KeysToAnyValues>
Parameters
- key: string
- kind: PluginStorageKind
Returns Promise<KeysToAnyValues>
Implementation of PluginServer.getStorageValue
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:106

`Protected`getStore

getStore(storeKey: string): Promise<KeysToKeysToAnyValue>
Parameters
- storeKey: string
Returns Promise<KeysToKeysToAnyValue>
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:115

`Protected`getStoreKey

getStoreKey(kind: PluginStorageKind): Promise<undefined | string>
The browser storage key holding the given kind of values, or undefined if there's nowhere to keep them - e.g. workspace state while no workspace is open.
Parameters
- kind: PluginStorageKind
Returns Promise<undefined | string>
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:157

getUninstalledPlugins

getUninstalledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
Implementation of PluginServer.getUninstalledPlugins
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:77

`Protected`getWebLocks

getWebLocks(): undefined | LockManager
The Web Locks API of this browsing context, or undefined in an insecure context or an older browser.

Returns undefined | LockManager
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:138

install

install(
    pluginEntry: string,
    type?: PluginType,
    options?: PluginDeployOptions,
): Promise<void>
Deploy a plugin.
Parameters
- pluginEntry: string
- Optionaltype: PluginType
  whether a plugin is installed by a system or a user, defaults to a user
- Optionaloptions: PluginDeployOptions
Returns Promise<void>
Implementation of PluginServer.install
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:57

`Protected`requestLock

requestLock<T>(
    locks: LockManager,
    name: string,
    callback: () => T | PromiseLike<T>,
): Promise<T>
Requests name from locks and runs callback once granted, same as LockManager.request().

LockGrantedCallback is typed as (lock: Lock | null) => T, which doesn't account for an async or never-settling callback even though the API itself supports and awaits one, hence the cast. Kept as its own method so a subclass or test can swap the lock implementation.
Type Parameters
- T
Parameters
- locks: LockManager
- name: string
- callback: () => T | PromiseLike<T>
Returns Promise<T>
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:149

setStorageValue

setStorageValue(
    key: string,
    value: KeysToAnyValues,
    kind: PluginStorageKind,
): Promise<boolean>
Parameters
- key: string
- value: KeysToAnyValues
- kind: PluginStorageKind
Returns Promise<boolean>
Implementation of PluginServer.setStorageValue
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:85

uninstall

uninstall(pluginId: `${string}.${string}@${string}`): Promise<void>
Parameters
- pluginId: `${string}.${string}@${string}`
Returns Promise<void>
Implementation of PluginServer.uninstall
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:61

`Protected`withStoreLock

withStoreLock<T>(storeKey: string, task: () => Promise<T>): Promise<T>
Runs task while holding the cross-tab lock for storeKey, via the Web Locks API, so a concurrent setStorageValue on this or another tab can't interleave with it.
Type Parameters
- T
Parameters
- storeKey: string
- task: () => Promise<T>
Returns Promise<T>
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-server.ts:123

Class BrowserOnlyPluginServer

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BrowserOnlyPluginServer

Properties

Protected ReadonlylocalLock

Protected Readonlylogger

ProtectedmissingLocksWarned

Protected ReadonlypluginPathsService

Protected ReadonlystorageService

Methods

disablePlugin

Parameters

Returns Promise<boolean>

enablePlugin

Parameters

Returns Promise<boolean>

getAllStorageValues

Parameters

Returns Promise<KeysToKeysToAnyValue>

getDisabledPlugins

Returns Promise<readonly `${string}.${string}`[]>

getInstalledPlugins

Returns Promise<readonly `${string}.${string}@${string}`[]>

getStorageValue

Parameters

Returns Promise<KeysToAnyValues>

ProtectedgetStore

Parameters

Returns Promise<KeysToKeysToAnyValue>

ProtectedgetStoreKey

Parameters

Returns Promise<undefined | string>

getUninstalledPlugins

Returns Promise<readonly `${string}.${string}@${string}`[]>

ProtectedgetWebLocks

Returns undefined | LockManager

install

Parameters

Returns Promise<void>

ProtectedrequestLock

Type Parameters

Parameters

Returns Promise<T>

setStorageValue

Parameters

Returns Promise<boolean>

uninstall

Parameters

Returns Promise<void>

ProtectedwithStoreLock

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

`Protected` `Readonly`localLock

`Protected` `Readonly`logger

`Protected`missingLocksWarned

`Protected` `Readonly`pluginPathsService

`Protected` `Readonly`storageService

`Protected`getStore

`Protected`getStoreKey

`Protected`getWebLocks

`Protected`requestLock

`Protected`withStoreLock