Move WebviewViewResolveContext to root namespace (eclipse-theia#11216)

The WebviewViewResolveContext was previously in the window namespace. Removed it in the window namespace and added it to root namespace. Fixes eclipse-theia#11149. Contributed on behalf of STMicroelectronics.
eclipsesource · Jun 2, 2022 · a6f438c · a6f438c
1 parent 83d4308
commit a6f438c
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 38 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@
 
 ## v1.27.0 - Unreleased
 
+- [plugin] moved `WebviewViewResolveContext` from `window` to `root` namespace [#11216](https://github.com/eclipse-theia/theia/pull/11216) - Contributed on behalf of STMicroelectronics
+
 <a name="breaking_changes_1.27.0">[Breaking Changes:](#breaking_changes_1.27.0)</a>
 
 - [plugin-dev] moved and renamed interface from: `@theia/debug/lib/browser/debug-contribution/DebugPluginConfiguration` to: `plugin-dev/src/common/PluginDebugConfiguration` [#11224](https://github.com/eclipse-theia/theia/pull/11224)

diff --git a/packages/plugin/src/theia.d.ts b/packages/plugin/src/theia.d.ts
@@ -4268,6 +4268,44 @@ export module '@theia/plugin' {
         resolveWebviewView(webviewView: WebviewView, context: WebviewViewResolveContext, token: CancellationToken): Thenable<void> | void;
     }
 
+    /**
+     * Additional information the webview view being resolved.
+     *
+     * @param T Type of the webview's state.
+     */
+    interface WebviewViewResolveContext<T = unknown> {
+        /**
+         * Persisted state from the webview content.
+         *
+         * To save resources, VS Code normally deallocates webview documents (the iframe content) that are not visible.
+         * For example, when the user collapse a view or switches to another top level activity in the sidebar, the
+         * `WebviewView` itself is kept alive but the webview's underlying document is deallocated. It is recreated when
+         * the view becomes visible again.
+         *
+         * You can prevent this behavior by setting `retainContextWhenHidden` in the `WebviewOptions`. However this
+         * increases resource usage and should be avoided wherever possible. Instead, you can use persisted state to
+         * save off a webview's state so that it can be quickly recreated as needed.
+         *
+         * To save off a persisted state, inside the webview call `acquireVsCodeApi().setState()` with
+         * any json serializable object. To restore the state again, call `getState()`. For example:
+         *
+         * ```js
+         * // Within the webview
+         * const vscode = acquireVsCodeApi();
+         *
+         * // Get existing state
+         * const oldState = vscode.getState() || { value: 0 };
+         *
+         * // Update state
+         * setState({ value: oldState.value + 1 })
+         * ```
+         *
+         * VS Code ensures that the persisted state is saved correctly when a webview is hidden and across
+         * editor restarts.
+         */
+        readonly state: T | undefined;
+    }
+
     /**
      * Common namespace for dealing with window and editor, showing messages and user input.
      */
@@ -4609,44 +4647,6 @@ export module '@theia/plugin' {
          * @param serializer Webview serializer.
          */
 
-        /**
-         * Additional information the webview view being resolved.
-         *
-         * @param T Type of the webview's state.
-         */
-        interface WebviewViewResolveContext<T = unknown> {
-            /**
-             * Persisted state from the webview content.
-             *
-             * To save resources, VS Code normally deallocates webview documents (the iframe content) that are not visible.
-             * For example, when the user collapse a view or switches to another top level activity in the sidebar, the
-             * `WebviewView` itself is kept alive but the webview's underlying document is deallocated. It is recreated when
-             * the view becomes visible again.
-             *
-             * You can prevent this behavior by setting `retainContextWhenHidden` in the `WebviewOptions`. However this
-             * increases resource usage and should be avoided wherever possible. Instead, you can use persisted state to
-             * save off a webview's state so that it can be quickly recreated as needed.
-             *
-             * To save off a persisted state, inside the webview call `acquireVsCodeApi().setState()` with
-             * any json serializable object. To restore the state again, call `getState()`. For example:
-             *
-             * ```js
-             * // Within the webview
-             * const vscode = acquireVsCodeApi();
-             *
-             * // Get existing state
-             * const oldState = vscode.getState() || { value: 0 };
-             *
-             * // Update state
-             * setState({ value: oldState.value + 1 })
-             * ```
-             *
-             * VS Code ensures that the persisted state is saved correctly when a webview is hidden and across
-             * editor restarts.
-             */
-            readonly state: T | undefined;
-        }
-
         export function registerWebviewViewProvider(viewId: string, provider: WebviewViewProvider, options?: {
             /**
              * Content settings for the webview created for this view.