WebViewHost => WebviewPanelHost WebView => WebviewPanel refactor (microsoft#13773)

Author: IanMatthewHuff

src/client/common/application/types.ts

@@ -1031,22 +1031,24 @@ export interface IApplicationEnvironment {
  readonly uriScheme: string;
 }
 
-export const IWebPanelMessageListener = Symbol('IWebPanelMessageListener');
-export interface IWebPanelMessageListener extends IAsyncDisposable {
+export interface IWebviewMessageListener {
  /**
- * Listens to web panel messages
+ * Listens to webview messages
  * @param message: the message being sent
  * @param payload: extra data that came with the message
- * @return A IWebPanel that can be used to show html pages.
  */
  onMessage(message: string, payload: any): void;
+}
+
+export const IWebviewPanelMessageListener = Symbol('IWebviewPanelMessageListener');
+export interface IWebviewPanelMessageListener extends IWebviewMessageListener, IAsyncDisposable {
  /**
  * Listens to web panel state changes
  */
- onChangeViewState(panel: IWebPanel): void;
+ onChangeViewState(panel: IWebviewPanel): void;
 }
 
-export type WebPanelMessage = {
+export type WebviewMessage = {
  /**
  * Message type
  */
@@ -1058,13 +1060,13 @@ export type WebPanelMessage = {
  payload?: any;
 };
 
-// Wraps the VS Code webview panel
-export const IWebPanel = Symbol('IWebPanel');
-export interface IWebPanel {
+// Wraps a VS Code webview
+export const IWebview = Symbol('IWebview');
+export interface IWebview {
  /**
- * Event is fired when the load for a web panel fails
+ * Sends a message to the hosted html page
  */
- readonly loadFailed: Event<void>;
+ postMessage(message: WebviewMessage): void;
  /**
  * Convert a uri for the local file system to one that can be used inside webviews.
  *
@@ -1077,6 +1079,15 @@ export interface IWebPanel {
  * ```
  */
  asWebviewUri(localResource: Uri): Uri;
+}
+
+// Wraps the VS Code webview panel
+export const IWebviewPanel = Symbol('IWebviewPanel');
+export interface IWebviewPanel extends IWebview {
+ /**
+ * Event is fired when the load for a web panel fails
+ */
+ readonly loadFailed: Event<void>;
  setTitle(val: string): void;
  /**
  * Makes the webpanel show up.
@@ -1089,11 +1100,6 @@ export interface IWebPanel {
  */
  isVisible(): boolean;
 
- /**
- * Sends a message to the hosted html page
- */
- postMessage(message: WebPanelMessage): void;
-
  /**
  * Attempts to close the panel if it's visible
  */
@@ -1109,35 +1115,31 @@ export interface IWebPanel {
  updateCwd(cwd: string): void;
 }
 
-export interface IWebPanelOptions {
+export interface IWebviewOptions {
+ rootPath: string;
+ cwd: string;
+ scripts: string[];
+}
+
+export interface IWebviewPanelOptions extends IWebviewOptions {
  viewColumn: ViewColumn;
- listener: IWebPanelMessageListener;
+ listener: IWebviewPanelMessageListener;
  title: string;
- rootPath: string;
  /**
  * Additional paths apart from cwd and rootPath, that webview would allow loading resources/files from.
  * E.g. required for webview to serve images from worksapces when nb is in a nested folder.
  */
  additionalPaths?: string[];
- scripts: string[];
- cwd: string;
  // tslint:disable-next-line: no-any
  settings?: any;
  // Web panel to use if supplied by VS code instead
  webViewPanel?: WebviewPanel;
 }
 
 // Wraps the VS Code api for creating a web panel
-export const IWebPanelProvider = Symbol('IWebPanelProvider');
-export interface IWebPanelProvider {
- /**
- * Creates a new webpanel
- *
- * @param {IWebPanelOptions} options - params for creating an IWebPanel
- * @returns {IWebPanel}
- * @memberof IWebPanelProvider
- */
- create(options: IWebPanelOptions): Promise<IWebPanel>;
+export const IWebviewPanelProvider = Symbol('IWebviewPanelProvider');
+export interface IWebviewPanelProvider {
+ create(options: IWebviewPanelOptions): Promise<IWebviewPanel>;
 }
 
 // Wraps the vsls liveshare API