@theia/plugin-ext 1.67.0-next.56 → 1.67.0-next.59

package/lib/main/browser/webview/webview.d.ts

@@ -0,0 +1,150 @@
+import { WebviewPanelOptions, WebviewPortMapping } from '@theia/plugin';
+import { BaseWidget, Message } from '@theia/core/lib/browser/widgets/widget';
+import { Disposable, DisposableCollection } from '@theia/core/lib/common/disposable';
+import { ApplicationShellMouseTracker } from '@theia/core/lib/browser/shell/application-shell-mouse-tracker';
+import { StatefulWidget } from '@theia/core/lib/browser/shell/shell-layout-restorer';
+import { WebviewPanelViewState } from '../../../common/plugin-api-rpc';
+import { IconUrl } from '../../../common/plugin-protocol';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import { WebviewEnvironment } from './webview-environment';
+import URI from '@theia/core/lib/common/uri';
+import { Emitter } from '@theia/core/lib/common/event';
+import { OpenerService } from '@theia/core/lib/browser/opener-service';
+import { KeybindingRegistry } from '@theia/core/lib/browser/keybinding';
+import { PluginSharedStyle } from '../plugin-shared-style';
+import { WebviewThemeDataProvider } from './webview-theme-data-provider';
+import { ExternalUriService } from '@theia/core/lib/browser/external-uri-service';
+import { OutputChannelManager } from '@theia/output/lib/browser/output-channel';
+import { WebviewResourceCache } from './webview-resource-cache';
+import { FileService } from '@theia/filesystem/lib/browser/file-service';
+import { ExtractableWidget } from '@theia/core/lib/browser/widgets/extractable-widget';
+import { MenuPath } from '@theia/core';
+import { ContextMenuRenderer } from '@theia/core/lib/browser';
+import { ContextKeyService } from '@theia/core/lib/browser/context-key-service';
+import { WebviewPreferences } from '../../common/webview-preferences';
+export declare const WEBVIEW_CONTEXT_MENU: MenuPath;
+export declare const enum WebviewMessageChannels {
+    onmessage = "onmessage",
+    didClickLink = "did-click-link",
+    didFocus = "did-focus",
+    didBlur = "did-blur",
+    doUpdateState = "do-update-state",
+    doReload = "do-reload",
+    loadResource = "load-resource",
+    loadLocalhost = "load-localhost",
+    webviewReady = "webview-ready",
+    didKeydown = "did-keydown",
+    didMouseDown = "did-mousedown",
+    didMouseUp = "did-mouseup",
+    onconsole = "onconsole",
+    didcontextmenu = "did-context-menu"
+}
+export interface WebviewContentOptions {
+    readonly allowScripts?: boolean;
+    readonly allowForms?: boolean;
+    readonly localResourceRoots?: ReadonlyArray<string>;
+    readonly portMapping?: ReadonlyArray<WebviewPortMapping>;
+    readonly enableCommandUris?: boolean | readonly string[];
+}
+export interface WebviewConsoleLog {
+    level: Extract<keyof typeof console, 'log' | 'info' | 'warn' | 'error' | 'trace' | 'debug'>;
+    message?: string;
+    optionalParams?: string;
+}
+export declare class WebviewWidgetIdentifier {
+    id: string;
+    viewId?: string;
+}
+export declare const WebviewWidgetExternalEndpoint: unique symbol;
+export declare class WebviewWidget extends BaseWidget implements StatefulWidget, ExtractableWidget {
+    private static readonly standardSupportedLinkSchemes;
+    static FACTORY_ID: string;
+    protected element: HTMLIFrameElement | undefined;
+    protected transparentOverlay: HTMLElement;
+    readonly identifier: WebviewWidgetIdentifier;
+    readonly externalEndpoint: string;
+    protected readonly mouseTracker: ApplicationShellMouseTracker;
+    protected readonly environment: WebviewEnvironment;
+    protected readonly openerService: OpenerService;
+    protected readonly keybindings: KeybindingRegistry;
+    protected readonly sharedStyle: PluginSharedStyle;
+    protected readonly themeDataProvider: WebviewThemeDataProvider;
+    protected readonly externalUriService: ExternalUriService;
+    protected readonly outputManager: OutputChannelManager;
+    protected readonly preferences: WebviewPreferences;
+    protected readonly fileService: FileService;
+    protected readonly resourceCache: WebviewResourceCache;
+    protected readonly contextMenuRenderer: ContextMenuRenderer;
+    protected readonly contextKeyService: ContextKeyService;
+    viewState: WebviewPanelViewState;
+    protected html: string;
+    protected _contentOptions: WebviewContentOptions;
+    get contentOptions(): WebviewContentOptions;
+    protected _state: string | undefined;
+    get state(): string | undefined;
+    viewType: string;
+    options: WebviewPanelOptions;
+    protected ready: Deferred<void>;
+    protected readonly onMessageEmitter: Emitter<any>;
+    readonly onMessage: import("@theia/core").Event<any>;
+    protected readonly pendingMessages: any[];
+    protected readonly toHide: DisposableCollection;
+    protected hideTimeout: any | number | undefined;
+    isExtractable: boolean;
+    secondaryWindow: Window | undefined;
+    protected init(): void;
+    protected onBeforeAttach(msg: Message): void;
+    protected onAfterAttach(msg: Message): void;
+    protected onBeforeShow(msg: Message): void;
+    protected onAfterHide(msg: Message): void;
+    protected doHide(): void;
+    protected forceHide(): void;
+    protected doShow(): void;
+    protected loadLocalhost(origin: string): Promise<void>;
+    protected dispatchMouseEvent(type: string, data: MouseEvent): void;
+    handleContextMenu(event: {
+        clientX: number;
+        clientY: number;
+        context: any;
+    }): void;
+    protected getRedirect(url: string): Promise<string | undefined>;
+    protected toRemoteUrl(localUri: URI): Promise<string>;
+    setContentOptions(contentOptions: WebviewContentOptions): void;
+    protected iconUrl: IconUrl | undefined;
+    protected readonly toDisposeOnIcon: DisposableCollection;
+    setIconUrl(iconUrl: IconUrl | undefined): void;
+    protected toEndpoint(pathname: string): string;
+    setHTML(value: string): void;
+    protected preprocessHtml(value: string): string;
+    protected onActivateRequest(msg: Message): void;
+    reload(): void;
+    protected forwardConsoleLog(log: WebviewConsoleLog): void;
+    protected style(): void;
+    protected openLink(link: URI): void;
+    protected toSupportedLink(link: URI): URI | undefined;
+    protected loadResource(requestPath: string, requestQuery?: string): Promise<void>;
+    protected normalizeRequestUri(requestPath: string): URI;
+    sendMessage(data: any): void;
+    protected doUpdateContent(): void;
+    storeState(): WebviewWidget.State;
+    restoreState(oldState: WebviewWidget.State): void;
+    setIframeHeight(height: number): void;
+    protected doSend(channel: string, data?: any): Promise<void>;
+    protected postMessage(channel: string, data?: any): void;
+    protected on<T = unknown>(channel: WebviewMessageChannels, handler: (data: T) => void): Disposable;
+    protected trace(kind: 'in' | 'out', channel: string, data?: any): void;
+}
+export declare namespace WebviewWidget {
+    namespace Styles {
+        const WEBVIEW = "theia-webview";
+    }
+    interface State {
+        viewType: string;
+        title: string;
+        iconUrl?: IconUrl;
+        options: WebviewPanelOptions;
+        contentOptions: WebviewContentOptions;
+        state?: string;
+    }
+}
+//# sourceMappingURL=webview.d.ts.map

package/lib/main/browser/webview/webview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webview.d.ts","sourceRoot":"","sources":["../../../../src/main/browser/webview/webview.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACrF,OAAO,EAAE,4BAA4B,EAAE,MAAM,+DAA+D,CAAC;AAC7G,OAAO,EAAE,cAAc,EAAE,MAAM,qDAAqD,CAAC;AACrF,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,GAAG,MAAM,4BAA4B,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EAAQ,aAAa,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAExE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8CAA8C,CAAC;AAClF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAChF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAE,MAAM,4CAA4C,CAAC;AAGzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAC;AACvF,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAEhF,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAKtE,eAAO,MAAM,oBAAoB,EAAE,QAAmC,CAAC;AAIvE,0BAAkB,sBAAsB;IACpC,SAAS,cAAc;IACvB,YAAY,mBAAmB;IAC/B,QAAQ,cAAc;IACtB,OAAO,aAAa;IACpB,aAAa,oBAAoB;IACjC,QAAQ,cAAc;IACtB,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,SAAS,cAAc;IACvB,cAAc,qBAAqB;CACtC;AAED,MAAM,WAAW,qBAAqB;IAClC,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;IACzD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,MAAM,EAAE,CAAC;CAC5D;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,OAAO,CAAC,MAAM,OAAO,OAAO,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC;IAC5F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,qBACa,uBAAuB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,6BAA6B,eAA0C,CAAC;AAErF,qBACa,aAAc,SAAQ,UAAW,YAAW,cAAc,EAAE,iBAAiB;IAEtF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,CAMjD;IAEH,MAAM,CAAC,UAAU,SAAoB;IAErC,SAAS,CAAC,OAAO,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAKjD,SAAS,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAG1C,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAC;IAG7C,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAGlC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC;IAG9D,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IAGnD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAGhD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IAGnD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IAGlD,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,wBAAwB,CAAC;IAG/D,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAG1D,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,oBAAoB,CAAC;IAGvD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IAGnD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAG5C,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,oBAAoB,CAAC;IAGvD,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAG5D,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAExD,SAAS,EAAE,qBAAqB,CAI9B;IAEF,SAAS,CAAC,IAAI,SAAM;IAEpB,SAAS,CAAC,eAAe,EAAE,qBAAqB,CAAM;IACtD,IAAI,cAAc,IAAI,qBAAqB,CAE1C;IAED,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAED,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,mBAAmB,CAAM;IAElC,SAAS,CAAC,KAAK,iBAAwB;IAEvC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,eAAsB;IACzD,QAAQ,CAAC,SAAS,mCAA+B;IACjD,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,CAAM;IAE/C,SAAS,CAAC,QAAQ,CAAC,MAAM,uBAA8B;IACvD,SAAS,CAAC,WAAW,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAAC;IAEhD,aAAa,EAAE,OAAO,CAAQ;IAC9B,eAAe,EAAE,MAAM,GAAG,SAAS,CAAa;IAGhD,SAAS,CAAC,IAAI,IAAI,IAAI;cAyBH,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;cAOlC,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;cASjC,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;cAKhC,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAKlD,SAAS,CAAC,MAAM,IAAI,IAAI;IASxB,SAAS,CAAC,SAAS,IAAI,IAAI;IAM3B,SAAS,CAAC,MAAM,IAAI,IAAI;cAoFR,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK5D,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI;IASlE,iBAAiB,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,GAAG,CAAA;KAAE,GAAG,IAAI;cAgBlE,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;cAsBrD,WAAW,CAAC,QAAQ,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAS3D,iBAAiB,CAAC,cAAc,EAAE,qBAAqB,GAAG,IAAI;IAQ9D,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,SAAS,CAAC,QAAQ,CAAC,eAAe,uBAA8B;IAChE,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI;IAqB9C,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI9C,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK5B,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;cAU5B,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAKxD,MAAM,IAAI,IAAI;IAId,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,iBAAiB,GAAG,IAAI;IASzD,SAAS,CAAC,KAAK,IAAI,IAAI;IAKvB,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAOnC,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS;cAoBrC,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IA6C3F,SAAS,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,GAAG;IAiBvD,WAAW,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAQ5B,SAAS,CAAC,eAAe,IAAI,IAAI;IAQjC,UAAU,IAAI,aAAa,CAAC,KAAK;IAWjC,YAAY,CAAC,QAAQ,EAAE,aAAa,CAAC,KAAK,GAAG,IAAI;IAUjD,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;cAMrB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAYlE,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IAWxD,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,UAAU;IAgBlG,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;CAgBzE;AACD,yBAAiB,aAAa,CAAC;IAC3B,UAAiB,MAAM,CAAC;QACb,MAAM,OAAO,kBAAkB,CAAC;KAC1C;IACD,UAAiB,KAAK;QAClB,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,OAAO,EAAE,mBAAmB,CAAA;QAC5B,cAAc,EAAE,qBAAqB,CAAA;QACrC,KAAK,CAAC,EAAE,MAAM,CAAA;KACjB;CACJ"}