Function buildApi

src/standalone/api/index.ts:30–87

(
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    ready: Promise<any>,
    serviceManager: IServiceManager,
    serviceContainer: IServiceContainer,
    context: IExtensionContext
)

export interface IExtensionApi extends Jupyter {}

export function buildApi(
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    ready: Promise<any>,
    serviceManager: IServiceManager,
    serviceContainer: IServiceContainer,
    context: IExtensionContext
): IExtensionApi {
    const extensions = serviceContainer.get<IExtensions>(IExtensions);
    const envApi = serviceContainer.get<INotebookPythonEnvironmentService>(INotebookPythonEnvironmentService);
    const api: IExtensionApi = {
        // 'ready' will propagate the exception, but we must log it here first.
        ready: getReady(ready),
        registerPythonApi: (pythonApi: PythonApi) => registerPythonApi(pythonApi, serviceContainer),
        registerRemoteServerProvider: (provider: IJupyterUriProvider) =>
            registerRemoteServerProvider(provider, serviceContainer),
        getKernelService: () => getKernelService(serviceContainer),
        addRemoteJupyterServer: (providerId: string, handle: string) =>
            addRemoteJupyterServer(providerId, handle, serviceContainer),
        openNotebook: async (uri: Uri, kernelOrPythonEnvId: string | EnvironmentPath) =>
            openNotebook(uri, kernelOrPythonEnvId, serviceContainer),
        createJupyterServerCollection: (id: string, label: string, serverProvider: JupyterServerProvider) => {
            return createJupyterServerCollection(
                id,
                label,
                serverProvider,
                extensions.determineExtensionFromCallStack().extensionId,
                serviceContainer
            );
        },
        get kernels() {
            return getKernelsApi(extensions.determineExtensionFromCallStack().extensionId);
        },
        // Only for use By Python, hence this is proposed API and can change anytime.
        // Do not add this to Kernels or other namespaces, as this is only for Python.
        onDidChangePythonEnvironment: envApi.onDidChangeEnvironment,
        // Only for use By Python, hence this is proposed API and can change anytime.
        // Do not add this to Kernels or other namespaces, as this is only for Python.
        getPythonEnvironment(uri: Uri): EnvironmentPath | undefined {
            // This is a proposed API that is only used by the Python extension.
            // Hence the reason to keep this separate.
            // This way we can keep the API stable for other extensions (which would be the majority case).
            return envApi.getPythonEnvironment(uri);
        }
    };

    // In test/dev environment return the DI Container.
    if (
        isTestExecution() ||
        context.extensionMode === ExtensionMode.Development ||
        context.extensionMode === ExtensionMode.Test
    ) {
        /* eslint-disable @typescript-eslint/no-explicit-any */
        (api as any).serviceContainer = serviceContainer;
        (api as any).serviceManager = serviceManager;
        /* eslint-enable @typescript-eslint/no-explicit-any */
    }
    return api;
}