@sourcegraph/extensions-client-common/lib/context.d.ts

/// <reference types="react" />
import { Subscribable } from 'rxjs';
import { ConfigurationUpdateParams } from 'sourcegraph/module/protocol';
import { Controller } from './controller';
import { QueryResult } from './graphql';
import * as GQL from './schema/graphqlschema';
import { ConfigurationCascadeOrError, ConfigurationSubject, ID, Settings } from './settings';
/**
 * Description of the context in which extensions-client-common is running, and platform-specific hooks.
 */
export interface Context<S extends ConfigurationSubject, C extends Settings> {
    /**
     * An observable that emits whenever the configuration cascade changes (including when any individual subject's
     * settings change).
     */
    readonly configurationCascade: Subscribable<ConfigurationCascadeOrError<S, C>>;
    /**
     * Updates the extension settings for extensionID and for the given subject.
     */
    updateExtensionSettings(subject: ID, args: {
        edit?: ConfigurationUpdateParams;
    } | {
        extensionID: string;
        enabled?: boolean;
        remove?: boolean;
    }): Subscribable<void>;
    /**
     * Sends a request to the Sourcegraph GraphQL API and returns the response.
     *
     * @param request The GraphQL request (query or mutation)
     * @param variables An object whose properties are GraphQL query name-value variable pairs
     * @return Observable that emits the result or an error if the HTTP request failed
     */
    queryGraphQL(request: string, variables?: {
        [name: string]: any;
    }): Subscribable<QueryResult<Pick<GQL.IQuery, 'extensionRegistry'>>>;
    /**
     * React components for icons. They are expected to size themselves appropriately with the surrounding DOM flow
     * content.
     */
    readonly icons: Record<'Loader' | 'Warning' | 'Menu' | 'CaretDown', React.ComponentType<{
        className: 'icon-inline' | string;
        onClick?: () => void;
    }>>;
    /**
     * Forces the currently displayed tooltip, if any, to update its contents.
     */
    forceUpdateTooltip(): void;
    /**
     * Experimental capabilities implemented by the client (that are not defined by the Sourcegraph extension API
     * specification). These capabilities are passed verbatim to extensions in the initialize request's
     * capabilities.experimental property.
     */
    experimentalClientCapabilities?: any;
}
/**
 * React partial props for components needing the extensions controller.
 */
export interface ExtensionsProps<S extends ConfigurationSubject, C extends Settings> {
    extensions: Controller<S, C>;
}