Does not exist in type 'CredentialBody | ExternalAccountClientOptions'

[Shidooo]

Environment details

• OS: Windows
• Node.js version: 16.14.0
• npm version: 8.3.1
• @google-cloud/storage version: 7.7.0

Problem

Can't create a client with credentials passed by value as a JavaScript object like the documentation mentioned.

  private readonly STORAGE = new Storage({
    projectId: 'your-project-id',
    credentials: {
      type: 'service_account',
      project_id: 'xxxxxxx',
      private_key_id: 'xxxx',
      private_key:'-----BEGIN PRIVATE KEY-----xxxxxxx\n-----END PRIVATE KEY-----\n',
      client_email: 'xxxx',
      client_id: 'xxx',
      auth_uri: 'https://accounts.google.com/o/oauth2/auth',
      token_uri: 'https://oauth2.googleapis.com/token',
      auth_provider_x509_cert_url: 'https://www.googleapis.com/oauth2/v1/certs',
      client_x509_cert_url: 'xxx',
      }
    });

When I'm following documentation, my IDE tells on private_key_id:

Object literal may only specify known properties, and 'private_key_id' does not exist in type 'CredentialBody | ExternalAccountClientOptions'.ts(2353)
googleauth.d.ts(52, 5): The expected type comes from property 'credentials' which is declared here on type 'StorageOptions'

As well for : private_key_id, auth_uri, token_uri, auth_provider_x509_cert_url, client_x509_cert_url

Expected behavior

Works as described in the documentation.

Thanks

[ddelgrosso1]

Hi @Shidooo it looks like the docs were never updated with changes to the auth client. I will get them updated. As you noted, those fields no longer exist.

[ddelgrosso1]

@danielbankhead in looking into this it also appears that the docs for auth might also be out of date: https://github.com/googleapis/google-auth-library-nodejs/blob/7ae4aaea0311de1a3e10f4e86a1ef93ff00656b5/README.md?plain=1#L296 looks like a lot of those fields no longer exist.

[danielbankhead]

Turns out this is a small bug in GoogleAuth's constructor parameters. Currently the GoogleAuthOptions.credentials type parameter is more limited in properties than the GoogleAuth#fromJSON method, although in their code paths are used in the exact same way.

Here's a PR to resolve:

• fix(GoogleAuth): Expand credentials type google-auth-library-nodejs#1719

However, some fields aren't directly used in the google-auth-library, but are used with glcoud. These can be omitted for now:

• auth_uri
• token_uri
• auth_provider_x509_cert_url
• client_x509_cert_url

[danielbankhead]

Fixed upstream