@sussudio/platform/progress/common/progress.d.mts

Internal APIs for VS Code's service injection the base services.

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { IAction } from '@sussudio/base/common/actions.mjs';
import { CancellationToken } from '@sussudio/base/common/cancellation.mjs';
import { Disposable } from '@sussudio/base/common/lifecycle.mjs';
export declare const IProgressService: import('../../instantiation/common/instantiation.mjs').ServiceIdentifier<IProgressService>;
/**
 * A progress service that can be used to report progress to various locations of the UI.
 */
export interface IProgressService {
	readonly _serviceBrand: undefined;
	withProgress<R>(
		options:
			| IProgressOptions
			| IProgressDialogOptions
			| IProgressNotificationOptions
			| IProgressWindowOptions
			| IProgressCompositeOptions,
		task: (progress: IProgress<IProgressStep>) => Promise<R>,
		onDidCancel?: (choice?: number) => void,
	): Promise<R>;
}
export interface IProgressIndicator {
	/**
	 * Show progress customized with the provided flags.
	 */
	show(infinite: true, delay?: number): IProgressRunner;
	show(total: number, delay?: number): IProgressRunner;
	/**
	 * Indicate progress for the duration of the provided promise. Progress will stop in
	 * any case of promise completion, error or cancellation.
	 */
	showWhile(promise: Promise<unknown>, delay?: number): Promise<void>;
}
export declare const enum ProgressLocation {
	Explorer = 1,
	Scm = 3,
	Extensions = 5,
	Window = 10,
	Notification = 15,
	Dialog = 20,
}
export interface IProgressOptions {
	readonly location: ProgressLocation | string;
	readonly title?: string;
	readonly source?:
		| string
		| {
				label: string;
				id: string;
		  };
	readonly total?: number;
	readonly cancellable?: boolean;
	readonly buttons?: string[];
}
export interface IProgressNotificationOptions extends IProgressOptions {
	readonly location: ProgressLocation.Notification;
	readonly primaryActions?: readonly IAction[];
	readonly secondaryActions?: readonly IAction[];
	readonly delay?: number;
	readonly silent?: boolean;
	readonly type?: 'syncing' | 'loading';
}
export interface IProgressDialogOptions extends IProgressOptions {
	readonly delay?: number;
	readonly detail?: string;
	readonly sticky?: boolean;
}
export interface IProgressWindowOptions extends IProgressOptions {
	readonly location: ProgressLocation.Window;
	readonly command?: string;
	readonly type?: 'syncing' | 'loading';
}
export interface IProgressCompositeOptions extends IProgressOptions {
	readonly location: ProgressLocation.Explorer | ProgressLocation.Extensions | ProgressLocation.Scm | string;
	readonly delay?: number;
}
export interface IProgressStep {
	message?: string;
	increment?: number;
	total?: number;
}
export interface IProgressRunner {
	total(value: number): void;
	worked(value: number): void;
	done(): void;
}
export declare const emptyProgressRunner: Readonly<IProgressRunner>;
export interface IProgress<T> {
	report(item: T): void;
}
export declare class Progress<T> implements IProgress<T> {
	private callback;
	static readonly None: Readonly<IProgress<unknown>>;
	private _value?;
	get value(): T | undefined;
	constructor(callback: (data: T) => void);
	report(item: T): void;
}
/**
 * A helper to show progress during a long running operation. If the operation
 * is started multiple times, only the last invocation will drive the progress.
 */
export interface IOperation {
	id: number;
	isCurrent: () => boolean;
	token: CancellationToken;
	stop(): void;
}
/**
 * RAII-style progress instance that allows imperative reporting and hides
 * once `dispose()` is called.
 */
export declare class UnmanagedProgress extends Disposable {
	private readonly deferred;
	private reporter?;
	private lastStep?;
	constructor(
		options:
			| IProgressOptions
			| IProgressDialogOptions
			| IProgressNotificationOptions
			| IProgressWindowOptions
			| IProgressCompositeOptions,
		progressService: IProgressService,
	);
	report(step: IProgressStep): void;
}
export declare class LongRunningOperation extends Disposable {
	private progressIndicator;
	private currentOperationId;
	private readonly currentOperationDisposables;
	private currentProgressRunner;
	private currentProgressTimeout;
	constructor(progressIndicator: IProgressIndicator);
	start(progressDelay: number): IOperation;
	stop(): void;
	private doStop;
}
export declare const IEditorProgressService: import('../../instantiation/common/instantiation.mjs').ServiceIdentifier<IEditorProgressService>;
/**
 * A progress service that will report progress local to the editor triggered from.
 */
export interface IEditorProgressService extends IProgressIndicator {
	readonly _serviceBrand: undefined;
}