Create a GraphQL wrapper API for extensions

client/packages/sourcegraph-extension-api/src/sourcegraph.d.ts

@@ -1609,6 +1609,17 @@ declare module 'sourcegraph' {
         export function executeCommand<T = any>(command: string, ...args: any[]): Promise<T>
     }
 
+    export namespace graphQL {
+        /**
+         * Executes a Sourcegraph GraphQL API query or mutation on the associated Sourcegraph instance and returns a promise for the result.
+         *
+         * @param query The GraphQL query
+         * @param variables A key/value object with variable values
+         * @returns Promise for the result of the GraphQL query
+         */
+        export function queryGraphQL<T = any>(query: string, variables: { [key: string]: any }): Promise<T>
+    }
+
     /**
      * A description of the information available at a URL.
      */

client/shared/src/api/extension/extensionHost.ts

@@ -148,6 +148,7 @@ function createExtensionAPI(
         commands,
         search,
         languages: { registerHoverProvider, registerDocumentHighlightProvider, registerDefinitionProvider },
+        graphQL,
     } = initNewExtensionAPI(proxy, initData.initialSettings, documents)
 
     // Expose the extension host API to the client (main thread)
@@ -254,6 +255,7 @@ function createExtensionAPI(
 
         search,
         commands,
+        graphQL,
         content: {
             registerLinkPreviewProvider: (urlMatchPattern: string, provider: sourcegraph.LinkPreviewProvider) =>
                 content.registerLinkPreviewProvider(urlMatchPattern, provider),

client/shared/src/api/extension/flatExtensionApi.ts

@@ -56,6 +56,7 @@ export interface InitResult {
         typeof sourcegraph['languages'],
         'registerHoverProvider' | 'registerDocumentHighlightProvider' | 'registerDefinitionProvider'
     >
+    graphQL: typeof sourcegraph['graphQL']
 }
 
 /**
@@ -226,6 +227,12 @@ export const initNewExtensionAPI = (
         provider: sourcegraph.DefinitionProvider
     ): sourcegraph.Unsubscribable => addWithRollback(state.definitionProviders, { selector, provider })
 
+    // GraphQL
+    const graphQL: typeof sourcegraph['graphQL'] = {
+        // `graphQL.queryGraphQL` is simply a discoverable wrapper over the `queryGraphQL` command.
+        queryGraphQL: (query, variables) => commands.executeCommand('queryGraphQL', query, variables),
+    }
+
     return {
         configuration: Object.assign(configChanges.asObservable(), {
             get: getConfiguration,
@@ -240,6 +247,7 @@ export const initNewExtensionAPI = (
             registerDocumentHighlightProvider,
             registerDefinitionProvider,
         },
+        graphQL,
     }
 }