@sourcegraph/extensions-client-common/lib/client/clientCommands.js

import { isArray } from 'lodash-es';
import { from, Subscription, throwError } from 'rxjs';
import { switchMap, take } from 'rxjs/operators';
import { isErrorLike } from '../errors';
/**
 * Registers the builtin client commands that are required for Sourcegraph extensions. See
 * {@link module:sourcegraph.module/protocol/contribution.ActionContribution#command} for
 * documentation.
 */
export function registerBuiltinClientCommands(context, controller) {
    const subscription = new Subscription();
    subscription.add(controller.registries.commands.registerCommand({
        command: 'open',
        run: (url) => {
            // The `open` client command is usually implemented by ActionItem rendering the action with the
            // HTML <a> element, not by handling it here. Using an HTML <a> element means it is a standard
            // link, and native system behaviors such as open-in-new-tab work.
            //
            // If a client is not running in a web browser, this handler should be updated to call the system's
            // default URL handler using the system (e.g., Electron) API.
            window.open(url, '_blank');
            return Promise.resolve();
        },
    }));
    subscription.add(controller.registries.commands.registerCommand({
        command: 'updateConfiguration',
        run: (...anyArgs) => {
            const args = anyArgs;
            return updateConfiguration(context, convertUpdateConfigurationCommandArgs(args));
        },
    }));
    /**
     * Sends a GraphQL request to the Sourcegraph GraphQL API and returns the result. The request is performed
     * with the privileges of the current user.
     */
    subscription.add(controller.registries.commands.registerCommand({
        command: 'queryGraphQL',
        run: (query, variables) => 
        // 🚨 SECURITY: The request might contain private info (such as
        // repository names), so the `mightContainPrivateInfo` parameter
        // is set to `true`. It is up to the client (e.g. browser
        // extension) to check that parameter and prevent the request
        // from being sent to Sourcegraph.com.
        from(context.queryGraphQL(query, variables, true)).toPromise(),
    }));
    /**
     * Sends a batched LSP request to the Sourcegraph LSP gateway API and returns the result. The request is
     * performed with the privileges of the current user.
     */
    subscription.add(controller.registries.commands.registerCommand({
        command: 'queryLSP',
        run: requests => from(context.queryLSP(requests)).toPromise(),
    }));
    return subscription;
}
/**
 * Applies an edit to the configuration settings of the highest-precedence subject.
 */
export function updateConfiguration(context, params) {
    // TODO(sqs): Allow extensions to specify which subject's configuration to update
    // (instead of always updating the highest-precedence subject's configuration).
    return from(context.configurationCascade)
        .pipe(take(1), switchMap(x => {
        if (!x.subjects) {
            return throwError(new Error('unable to update configuration: no configuration subjects available'));
        }
        if (isErrorLike(x.subjects)) {
            return throwError(new Error(`unable to update configuration: error retrieving configuration subjects: ${x.subjects.message}`));
        }
        const subject = x.subjects[x.subjects.length - 1].subject;
        return context.updateExtensionSettings(subject.id, { edit: params });
    }))
        .toPromise();
}
/**
 * Converts the arguments for the `updateConfiguration` client command (as documented in
 * {@link ActionContributionClientCommandUpdateConfiguration#commandArguments})
 * to {@link ConfigurationUpdateParams}.
 */
export function convertUpdateConfigurationCommandArgs(args) {
    if (!isArray(args) ||
        !(args.length >= 2 && args.length <= 4) ||
        !isArray(args[0]) ||
        !(args[2] === undefined || args[2] === null)) {
        throw new Error(`invalid updateConfiguration arguments: ${JSON.stringify(args)}`);
    }
    const valueIsJSONEncoded = args.length === 4 && args[3] === 'json';
    return { path: args[0], value: valueIsJSONEncoded ? JSON.parse(args[1]) : args[1] };
}
//# sourceMappingURL=clientCommands.js.map