docs: fix jsdoc and linkinator (#1965)

* docs: fix `jsoc`

* chore: fix docs includes

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* chore: minor clean-up

* docs: Include documentation for `AuthClient` so it can be rendered

* fix: add retries for 429s

https://github.com/JustinBeckwith/linkinator-action?tab=readme-ov-file#inputs

* chore: more linkinator

* chore: sanity check

* chore: remove concurrency

* chore: more clean-up

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* docs: skip blobs

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: d-goog

.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ jobs:
       matrix:
         node: [18, 20, 22]
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
@@ -22,25 +22,39 @@ jobs:
       - run: npm install --production --engine-strict --ignore-scripts --no-package-lock
       # Clean up the production install, before installing dev/production:
       - run: rm -rf node_modules
-      - run: npm install
+      - run: npm install --engine-strict
+      - run: npm test
+        env:
+          MOCHA_THROW_DEPRECATION: false
+  test-script:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - run: node --version
+      - run: npm install --engine-strict
+        working-directory: .github/scripts
       - run: npm test
+        working-directory: .github/scripts
         env:
           MOCHA_THROW_DEPRECATION: false
   windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 18
-      - run: npm install
+      - run: npm install --engine-strict
       - run: npm test
         env:
           MOCHA_THROW_DEPRECATION: false
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 18
@@ -49,5 +63,12 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      # See: https://github.com/JustinBeckwith/linkinator-action/issues/148
-      - run: echo "temporarily skipping until linkinator's fixed upstream"
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - run: npm install
+      - run: npm run docs
+      - uses: JustinBeckwith/linkinator-action@v1
+        with:
+          paths: docs/

.jsdoc.js

@@ -22,30 +22,24 @@ module.exports = {
     template: './node_modules/jsdoc-fresh',
     recurse: true,
     verbose: true,
-    destination: './docs/'
+    destination: './docs/',
   },
-  plugins: [
-    'plugins/markdown',
-    'jsdoc-region-tag'
-  ],
+  plugins: ['plugins/markdown', 'jsdoc-region-tag'],
   source: {
-    excludePattern: '(^|\\/|\\\\)[._]',
-    include: [
-      'build/src',
-    ],
-    includePattern: '\\.js$'
+    include: ['build/src'],
+    includePattern: '\\.js$',
   },
   templates: {
-    copyright: 'Copyright 2019 Google, LLC.',
+    copyright: 'Copyright 2019 Google LLC',
     includeDate: false,
     sourceFiles: false,
     systemName: 'google-auth-library',
     theme: 'lumen',
     default: {
-      outputSourceFiles: false
-    }
+      outputSourceFiles: false,
+    },
   },
   markdown: {
-    idInHeadings: true
-  }
+    idInHeadings: true,
+  },
 };

linkinator.config.json

@@ -4,8 +4,12 @@
     "https://codecov.io/gh/googleapis/",
     "www.googleapis.com",
     "img.shields.io",
-    "http://169.254.169.254/latest/api/token%22"
+    "http://169.254.169.254/latest/api/token%22",
+    "https://github.com/googleapis/google-auth-library-nodejs/blob/"
   ],
   "silent": true,
-  "concurrency": 10
+  "retry": true,
+  "retryErrors": true,
+  "retryErrorsCount": 3,
+  "retryErrorsJitter": 5
 }

owlbot.py

@@ -21,7 +21,6 @@
 # List of excludes for the enhanced library
 node.owlbot_main(
     templates_excludes=[
-        ".github/workflows/ci.yaml",
         ".github/ISSUE_TEMPLATE/bug_report.yml"
     ],
 )

package.json

@@ -74,7 +74,7 @@
     "compile": "tsc -p .",
     "fix": "gts fix",
     "pretest": "npm run compile -- --sourceMap",
-    "docs": "jsdoc -c .jsdoc.json",
+    "docs": "jsdoc -c .jsdoc.js",
     "samples-setup": "cd samples/ && npm link ../ && npm run setup && cd ../",
     "samples-test": "cd samples/ && npm link ../ && npm test && cd ../",
     "system-test": "mocha build/system-test --timeout 60000",

src/auth/authclient.ts

@@ -198,6 +198,9 @@ export declare interface AuthClient {
   on(event: 'tokens', listener: (tokens: Credentials) => void): this;
 }
 
+/**
+ * The base of all Auth Clients.
+ */
 export abstract class AuthClient
   extends EventEmitter
   implements CredentialsClient