TypeScript issue: Type 'JSONClient | Compute' is not assignable to type 'JSONClient'

[therealgilles]

I am trying to find the proper type for auth.getClient() in the code below:

let authClient: import('google-auth-library/build/src/auth/googleauth').JSONClient

const sheets = async (): Promise<sheets_v4.Sheets> => {
        try {
          if (!authClient) {
            // create a new JWT client using the key file downloaded from the Google Developer Console
            const auth = new google.auth.GoogleAuth({
              keyFile: ...,
              scopes: ...,
            })
            authClient = await auth.getClient()
          }

          return google.sheets({ version: 'v4', auth: authClient })
        } catch (err) {
          error(err)
          throw new Error(err)
        }

It seems it should be JSONClient but having to access the type through an import seems odd and then I get the following error:

Type 'JSONClient | Compute' is not assignable to type 'JSONClient'

Some advice/guidance would be appreciated.

[danielbankhead]

The appropriate type would be AuthClient:

import {AuthClient} from 'google-auth-library';

You can use the ReturnType utility as well:

type myType = ReturnType<GoogleAuth['getClient']>

Ref: https://www.typescriptlang.org/docs/handbook/utility-types.html#returntypetype

[therealgilles]

Thank you for your quick reply @danielbankhead.

I tried AuthClient first and got this error on the google.sheets() call:

(property) GeneratedAPIs.sheets: (version: "v4") => sheets_v4.Sheets (+1 overload)

No overload matches this call.
  Overload 1 of 2, '(version: "v4"): Sheets', gave the following error.
    Argument of type '{ version: string; auth: AuthClient; }' is not assignable to parameter of type '"v4"'.
  Overload 2 of 2, '(options: Options): Sheets', gave the following error.
    Type 'AuthClient' is not assignable to type 'string | BaseExternalAccountClient | GoogleAuth<JSONClient> | OAuth2Client | undefined'.
      Type 'AuthClient' is missing the following properties from type 'OAuth2Client': certificateCache, certificateExpiry, certificateCacheFormat, refreshTokenPromises, and 26 more.ts(2769)
[api.d.ts(24, 5): ]()The expected type comes from property 'auth' which is declared here on type 'Options'

I tried your second suggestion too, and got a similar error:

(property) GeneratedAPIs.sheets: (version: "v4") => sheets_v4.Sheets (+1 overload)

No overload matches this call.
  Overload 1 of 2, '(version: "v4"): Sheets', gave the following error.
    Argument of type '{ version: string; auth: Promise<JSONClient | Compute>; }' is not assignable to parameter of type '"v4"'.
  Overload 2 of 2, '(options: Options): Sheets', gave the following error.
    Type 'Promise<JSONClient | Compute>' is not assignable to type 'string | BaseExternalAccountClient | OAuth2Client | GoogleAuth<JSONClient> | undefined'.ts(2769)
[api.d.ts(24, 5): ]()The expected type comes from property 'auth' which is declared here on type 'Options'

What do you suggest?

[danielbankhead]

Thanks for the additional information - I now understand the error is on the return google.sheets({ version: 'v4', auth: authClient }) line.

You can pass the GoogleAuth instance directly to google.sheets:

const auth = new google.auth.GoogleAuth({
  keyFile: ...,
  scopes: ...,
});

return google.sheets({version: 'v4', auth});

[therealgilles]

I used to pass the GoogleAuth object directly. I believe the example or documentation I looked up after upgrading to the latest version now says to use the auth client.

[danielbankhead]

Thanks @therealgilles, do you have a link? I can further look into our guidance on this.

In addition to directly passing GoogleAuth, you can also change this line in your original post (using the Awaited utility):

let authClient: Awaited<ReturnType<Auth.GoogleAuth['getClient']>>;

or if running TypeScript < 4.5:

let authClient: import('google-auth-library/build/src/auth/googleauth').JSONClient | Auth.Compute;

[therealgilles]

Thanks again for your quick response.

Here is a link: https://googleapis.dev/nodejs/googleapis/latest/sheets/index.html#service-account-credentials

const docs = require('@googleapis/docs')

const auth = new docs.auth.GoogleAuth({
  keyFilename: 'PATH_TO_SERVICE_ACCOUNT_KEY.json',
    // Scopes can be specified either as an array or as a single, space-delimited string.
  scopes: ['https://www.googleapis.com/auth/documents']
});
const authClient = await auth.getClient();

const client = await docs.docs({
    version: 'v1',
    auth: authClient
});

Here is another link: https://github.com/googleapis/google-api-nodejs-client/blob/main/samples/jwt.js

 // Create a new JWT client using the key file downloaded from the Google Developer Console
  const auth = new google.auth.GoogleAuth({
    keyFile: path.join(__dirname, 'jwt.keys.json'),
    scopes: 'https://www.googleapis.com/auth/drive.readonly',
  });
  const client = await auth.getClient();

  // Obtain a new drive client, making sure you pass along the auth client
  const drive = google.drive({
    version: 'v2',
    auth: client,
  });

[danielbankhead]

Thanks, I can see how this is confusing - I synced with the team and I'll file an issue to update the documentation; I'm sure others would be confused as well. You can continue to directly pass GoogleAuth into the auth parameter.

Thanks for bringing this up!