115 lines
2.1 KiB
TypeScript
115 lines
2.1 KiB
TypeScript
|
import { logger, field } from "@coder/logger";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Handle for a notification that allows it to be closed and updated.
|
||
|
|
*/
|
||
|
|
export interface INotificationHandle {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Closes the notification.
|
||
|
|
*/
|
||
|
|
close(): void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the message.
|
||
|
|
*/
|
||
|
|
updateMessage(message: string): void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Update the buttons.
|
||
|
|
*/
|
||
|
|
updateButtons(buttons: INotificationButton[]): void;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Notification severity.
|
||
|
|
*/
|
||
|
|
export enum Severity {
|
||
|
|
Ignore = 0,
|
||
|
|
Info = 1,
|
||
|
|
Warning = 2,
|
||
|
|
Error = 3,
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Notification button.
|
||
|
|
*/
|
||
|
|
export interface INotificationButton {
|
||
|
|
label: string;
|
||
|
|
run(): void;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Optional notification service.
|
||
|
|
*/
|
||
|
|
export interface INotificationService {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display an error message.
|
||
|
|
*/
|
||
|
|
error(error: Error): void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Show a notification.
|
||
|
|
*/
|
||
|
|
prompt(severity: Severity, message: string, buttons: INotificationButton[], onCancel: () => void): INotificationHandle;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Updatable progress.
|
||
|
|
*/
|
||
|
|
export interface IProgress {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Report progress. Progress is the completed percentage from 0 to 100.
|
||
|
|
*/
|
||
|
|
report(progress: number): void;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Option progress reporting service.
|
||
|
|
*/
|
||
|
|
export interface IProgressService {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Start a new progress bar that resolves & disappears when the task finishes.
|
||
|
|
*/
|
||
|
|
start<T>(title: string, task: (progress: IProgress) => Promise<T>, onCancel: () => void): Promise<T>;
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Temporary notification service.
|
||
|
|
*/
|
||
|
|
export class NotificationService implements INotificationService {
|
||
|
|
|
||
|
|
public error(error: Error): void {
|
||
|
|
logger.error(error.message, field("error", error));
|
||
|
|
}
|
||
|
|
|
||
|
|
public prompt(_severity: Severity, message: string, _buttons: INotificationButton[], _onCancel: () => void): INotificationHandle {
|
||
|
|
throw new Error(`cannot prompt using the console: ${message}`);
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Temporary progress service.
|
||
|
|
*/
|
||
|
|
export class ProgressService implements IProgressService {
|
||
|
|
|
||
|
|
public start<T>(title: string, task: (progress: IProgress) => Promise<T>): Promise<T> {
|
||
|
|
logger.info(title);
|
||
|
|
|
||
|
|
return task({
|
||
|
|
report: (progress): void => {
|
||
|
|
logger.info(`${title} progress: ${progress}`);
|
||
|
|
},
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|