From 0b5b7afbacb659a426477c29ede763e85126f171 Mon Sep 17 00:00:00 2001 From: Kyle Carberry Date: Wed, 27 Feb 2019 09:03:44 -0600 Subject: [PATCH] Update IDE api --- packages/ide-api/api.d.ts | 116 ++++++++++++++++++++++++++++++---- packages/ide-api/package.json | 1 + packages/vscode/src/client.ts | 12 +++- 3 files changed, 116 insertions(+), 13 deletions(-) diff --git a/packages/ide-api/api.d.ts b/packages/ide-api/api.d.ts index 5d09b7460..aeaff7a05 100644 --- a/packages/ide-api/api.d.ts +++ b/packages/ide-api/api.d.ts @@ -4,12 +4,90 @@ interface ActiveEvalEmitter { emit(event: string, ...args: any[]): void; on(event: string, cb: (...args: any[]) => void): void; } -interface Disposer { - onDidDispose: (cb: () => void) => void; +interface IDisposable { dispose(): void; } -interface IdeApi { - readonly client: { +interface Disposer extends IDisposable { + onDidDispose: (cb: () => void) => void; +} +interface Event { + (listener: (e: T) => any, thisArgs?: any, disposables?: IDisposable[]): IDisposable; +} +interface IAction extends IDisposable { + id: string; + label: string; + tooltip: string; + class: string | undefined; + enabled: boolean; + checked: boolean; + radio: boolean; + run(event?: any): Promise; +} +interface IStatusbarEntry { + readonly text: string; + readonly tooltip?: string; + readonly color?: string; + readonly command?: string; + readonly arguments?: any[]; + readonly showBeak?: boolean; +} +interface IStatusbarService { + addEntry(entry: IStatusbarEntry, alignment: StatusbarAlignment, priority?: number): IDisposable; + setStatusMessage(message: string, autoDisposeAfter?: number, delayBy?: number): IDisposable; +} +type NotificationMessage = string | Error; +interface INotificationProperties { + sticky?: boolean; + silent?: boolean; +} +interface INotification extends INotificationProperties { + severity: Severity; + message: NotificationMessage; + source?: string; + actions?: INotificationActions; +} +interface INotificationActions { + primary?: IAction[]; + secondary?: IAction[]; +} + +interface INotificationProgress { + infinite(): void; + total(value: number): void; + worked(value: number): void; + done(): void; +} + +export interface INotificationHandle { + readonly onDidClose: Event; + readonly progress: INotificationProgress; + updateSeverity(severity: Severity): void; + updateMessage(message: NotificationMessage): void; + updateActions(actions?: INotificationActions): void; + close(): void; +} + +export interface IPromptChoice { + label: string; + isSecondary?: boolean; + keepOpen?: boolean; + run: () => void; +} + +export interface IPromptOptions extends INotificationProperties { + onCancel?: () => void; +} + +export interface INotificationService { + notify(notification: INotification): INotificationHandle; + info(message: NotificationMessage | NotificationMessage[]): void; + warn(message: NotificationMessage | NotificationMessage[]): void; + error(message: NotificationMessage | NotificationMessage[]): void; + prompt(severity: Severity, message: string, choices: IPromptChoice[], options?: IPromptOptions): INotificationHandle; +} + +declare namespace ide { + export const client: { run(func: (helper: ActiveEvalEmitter) => Disposer): ActiveEvalEmitter; run(func: (helper: ActiveEvalEmitter, a1: T1) => Disposer, a1: T1): ActiveEvalEmitter; run(func: (helper: ActiveEvalEmitter, a1: T1, a2: T2) => Disposer, a1: T1, a2: T2): ActiveEvalEmitter; @@ -26,13 +104,29 @@ interface IdeApi { evaluate(func: (helper: EvalHelper, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5) => R | Promise, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5): Promise; evaluate(func: (helper: EvalHelper, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5, a6: T6) => R | Promise, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5, a6: T6): Promise; }; - readonly workbench: { - getService(identifier: any): T | undefined; + + export const workbench: { + readonly statusbarService: IStatusbarService; + readonly notificationService: INotificationService; }; + + export enum Severity { + Ignore = 0, + Info = 1, + Warning = 2, + Error = 3 + } + + export enum StatusbarAlignment { + LEFT = 0, + RIGHT = 1, + } } -declare interface Window { - ide?: IdeApi; - - addEventListener(event: "ide-ready", callback: (ide: CustomEvent & { readonly ide: IdeApi }) => void): void; -} \ No newline at end of file +declare global { + interface Window { + ide?: typeof ide; + + addEventListener(event: "ide-ready", callback: (ide: CustomEvent & { readonly ide: IdeApi }) => void): void; + } +} diff --git a/packages/ide-api/package.json b/packages/ide-api/package.json index 952fd5b2c..ec622c9a8 100644 --- a/packages/ide-api/package.json +++ b/packages/ide-api/package.json @@ -1,5 +1,6 @@ { "name": "@coder/ide-api", + "version": "1.0.1", "typings": "api.d.ts", "author": "Coder", "license": "MIT", diff --git a/packages/vscode/src/client.ts b/packages/vscode/src/client.ts index ebec1a866..924df5235 100644 --- a/packages/vscode/src/client.ts +++ b/packages/vscode/src/client.ts @@ -1,5 +1,8 @@ import { IdeClient } from "@coder/ide"; import { client as ideClientInstance } from "@coder/ide/src/fill/client"; +import Severity from "vs/base/common/severity"; +import { INotificationService } from "vs/platform/notification/common/notification"; +import { IStatusbarService } from "vs/platform/statusbar/common/statusbar"; import * as paths from "./fill/paths"; import "./vscode.scss"; // NOTE: shouldn't import anything from VS Code here or anything that will @@ -16,12 +19,17 @@ class VSClient extends IdeClient { const { workbench } = require("./workbench") as typeof import("./workbench"); await workbench.initialize(); + // tslint:disable-next-line:no-any + const getService = (id: any): T => workbench.serviceCollection.get(id) as T; + enum StatusbarAlignment { LEFT, RIGHT } window.ide = { client: ideClientInstance, workbench: { - // tslint:disable-next-line:no-any - getService: (id: any): T => workbench.serviceCollection.get(id) as T, + statusbarService: getService(IStatusbarService), + notificationService: getService(INotificationService), }, + Severity: Severity, + StatusbarAlignment: StatusbarAlignment, }; const event = new CustomEvent("ide-ready");