spring-tools/vscode-extensions/vscode-spring-boot/lib/api.d.ts

import { Event, Uri } from "vscode";
import { LanguageClient } from "vscode-languageclient/node";
import { LiveProcess } from "./notification";
import {Location} from "vscode-languageclient";

export interface ExtensionAPI {
    readonly client: LanguageClient;

    /**
     * An event which fires on live process is connected. Payload is processKey.
     */
    readonly onDidLiveProcessConnect: Event<LiveProcess>

    /**
     * An event which fires on live process is disconnected. Payload is processKey.
     */
    readonly onDidLiveProcessDisconnect: Event<LiveProcess>

	/**
     * An event which fires on live process data change. Payload is processKey.
     */
	readonly onDidLiveProcessUpdate: Event<LiveProcess>

    /**
     * An event which fires on live process gcpauses metrics data change. Payload is processKey.
     */
	readonly onDidLiveProcessGcPausesMetricsUpdate: Event<LiveProcess>

    /**
     * An event which fires on live process memory metrics data change. Payload is processKey.
     */
	readonly onDidLiveProcessMemoryMetricsUpdate: Event<LiveProcess>

    /**
     * A command to get live process data.
     */
    readonly getLiveProcessData: (query: SimpleQuery | BeansQuery ) => Promise<any>

    /**
     * A command to refresh live process data.
     */
     readonly refreshLiveProcessData: (query: SimpleQuery | BeansQuery) => Promise<any>;

    /**
     * A command to get live process metrics data.
     */
     readonly getLiveProcessMetricsData: (query: MetricsQuery) => Promise<any>;

    /**
     * A command to refresh live process metrics data.
     */
     readonly refreshLiveProcessMetricsData: (query: MetricsQuery) => Promise<any>;

    /**
     * A command to list all currently connected processes.
     * 
     * Returns a list of processKeys.
     */
    readonly listConnectedProcesses: () => Promise<LiveProcess[]>;

    /**
     * Spring Model capable of computing beans and other static spring related information
     *
     * Returns Spring Model object.
     */
    readonly getSpringIndex: () => SpringIndex;

}

interface LiveProcessDataQuery {
    /**
     * unique identifier of a connected live process.
     */
    processKey: string;
}

interface SimpleQuery extends LiveProcessDataQuery {
    endpoint: "mappings" | "contextPath" | "port" | "properties" | "profiles";
}

interface BeansQuery extends LiveProcessDataQuery {
    endpoint: "beans";
    /**
     * if provided, return corresponding beans via name.
     */
    beanName?: string;
    dependingOn?: string;
}

interface MetricsQuery extends LiveProcessDataQuery {
    endpoint: "metrics";
    metricName: string;
    tags?: string;
}

interface Bean {
    readonly name: string;
    readonly type: string;
    readonly location: Location;
    readonly injectionPoints: InjectionPoint[];
    readonly supertypes: string[];
}

interface InjectionPoint {
    readonly name: string;
    readonly type: string;
    readonly location: Location;
}

interface SpringIndex {
   readonly beans: (params: BeansParams) =>  Promise<Bean[]>;
   readonly onSpringIndexUpdated: Event<void>;
}

interface BeansParams {
    projectName: string;
}