chore(deps-dev): bump typedoc to 0.23.23 (#4515)

* chore(bump-typedoc): bump typedoc to ^0.23.23 * feat(add-footer): add footer to core theme * chore(pin-typedoc): pin typedoc to 0.23.23 * fix(remove-private-docs): and format typedoc.json * fix(urls): mimic historic client urls * fix(revert): revert to exclude ruleset and mimic current navigation experience * fix(docs): pin typedoc in private/* * fix(theme): redirect regression and add border to classes index section * fix(theme): slight modification of border in theme
aws · Mar 14, 2023 · 6604067 · 6604067
1 parent e77e115
commit 6604067
Show file tree

Hide file tree

Showing 845 changed files with 3,192 additions and 3,049 deletions.
diff --git a/README.md b/README.md
@@ -330,13 +330,13 @@ Many AWS operations return paginated results when the response object is too lar
 
 In AWS SDK for JavaScript v3 we’ve improved pagination using async generator functions, which are similar to generator functions, with the following differences:
 
-- When called, async generator functions return an object, an async generator whose methods (`next`, `throw`, and `return`) return promises for { `value`, `done` }, instead of directly returning { `value`, `done` }. This automatically makes the returned async generator objects async iterators.
+- When called, async generator functions return an object, an async generator whose methods (`next`, `throw`, and `return`) return promises for `{ `value`, `done` }`, instead of directly returning `{ `value`, `done` }`. This automatically makes the returned async generator objects async iterators.
 - await expressions and `for await (x of y)` statements are allowed.
 - The behavior of `yield*` is modified to support delegation to async iterables.
 
 The Async Iterators were added in the ES2018 iteration of JavaScript. They are supported by Node.js 10.x+ and by all modern browsers, including Chrome 63+, Firefox 57+, Safari 11.1+, and Edge 79+. If you’re using TypeScript v2.3+, you can compile Async Iterators to older versions of JavaScript.
 
-An async iterator is much like an iterator, except that its `next()` method returns a promise for a { `value`, `done` } pair. As an implicit aspect of the Async Iteration protocol, the next promise is not requested until the previous one resolves. This is a simple, yet a very powerful pattern.
+An async iterator is much like an iterator, except that its `next()` method returns a promise for a `{ `value`, `done` }` pair. As an implicit aspect of the Async Iteration protocol, the next promise is not requested until the previous one resolves. This is a simple, yet a very powerful pattern.
 
 #### Example Pagination Usage
 
@@ -511,27 +511,28 @@ For a full middleware stack deep dive please check out our [blog post](https://a
 
 ## Release Cadence
 
-Our releases usually happen once per weekday. Each release increments the 
+Our releases usually happen once per weekday. Each release increments the
 minor version, e.g. 3.200.0 -> 3.201.0.
 
 ## Stability of Modular Packages
 
-|Package name|containing folder|API controlled by|stability|
-|---|---|---|---|
-|@aws-sdk/client-* Commands|clients|AWS service teams|public/stable|
-|@aws-sdk/client-* Clients|clients|AWS SDK JS team|public/stable|
-|@aws-sdk/lib-*|lib|AWS SDK JS team|public/stable|
-|@aws-sdk/*-signer|packages|AWS SDK JS team|public/stable|
-|@aws-sdk/middleware-stack|packages|AWS SDK JS team|public/stable|
-|remaining @aws-sdk/*|packages|AWS SDK JS team|internal|
+| Package name                | containing folder | API controlled by | stability     |
+| --------------------------- | ----------------- | ----------------- | ------------- |
+| @aws-sdk/client-\* Commands | clients           | AWS service teams | public/stable |
+| @aws-sdk/client-\* Clients  | clients           | AWS SDK JS team   | public/stable |
+| @aws-sdk/lib-\*             | lib               | AWS SDK JS team   | public/stable |
+| @aws-sdk/\*-signer          | packages          | AWS SDK JS team   | public/stable |
+| @aws-sdk/middleware-stack   | packages          | AWS SDK JS team   | public/stable |
+| remaining @aws-sdk/\*       | packages          | AWS SDK JS team   | internal      |
 
 Additional notes:
+
 - internal does not mean a package or interface is constantly changing
-or being actively worked on. It means it is subject to change without any
-notice period. The changes are included in the release notes.
+  or being actively worked on. It means it is subject to change without any
+  notice period. The changes are included in the release notes.
 - public interfaces such as client configuration are also subject to change
- in exceptional cases. We will try to undergo a deprecation period with 
- an advance notice.
+  in exceptional cases. We will try to undergo a deprecation period with
+  an advance notice.
 
 ## Known Issues
 

diff --git a/clients/client-accessanalyzer/package.json b/clients/client-accessanalyzer/package.json
@@ -63,14 +63,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-accessanalyzer/typedoc.json b/clients/client-accessanalyzer/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-account/package.json b/clients/client-account/package.json
@@ -61,14 +61,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-account/typedoc.json b/clients/client-account/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-acm-pca/package.json b/clients/client-acm-pca/package.json
@@ -62,14 +62,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-acm-pca/typedoc.json b/clients/client-acm-pca/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-acm/package.json b/clients/client-acm/package.json
@@ -62,14 +62,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-acm/typedoc.json b/clients/client-acm/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-alexa-for-business/package.json b/clients/client-alexa-for-business/package.json
@@ -63,14 +63,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-alexa-for-business/typedoc.json b/clients/client-alexa-for-business/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-amp/package.json b/clients/client-amp/package.json
@@ -64,14 +64,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-amp/typedoc.json b/clients/client-amp/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-amplify/package.json b/clients/client-amplify/package.json
@@ -61,14 +61,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-amplify/typedoc.json b/clients/client-amplify/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-amplifybackend/package.json b/clients/client-amplifybackend/package.json
@@ -61,14 +61,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-amplifybackend/typedoc.json b/clients/client-amplifybackend/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-amplifyuibuilder/package.json b/clients/client-amplifyuibuilder/package.json
@@ -63,14 +63,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-amplifyuibuilder/typedoc.json b/clients/client-amplifyuibuilder/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-api-gateway/package.json b/clients/client-api-gateway/package.json
@@ -62,14 +62,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-api-gateway/typedoc.json b/clients/client-api-gateway/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-apigatewaymanagementapi/package.json b/clients/client-apigatewaymanagementapi/package.json
@@ -61,14 +61,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-apigatewaymanagementapi/typedoc.json b/clients/client-apigatewaymanagementapi/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-apigatewayv2/package.json b/clients/client-apigatewayv2/package.json
@@ -61,14 +61,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-apigatewayv2/typedoc.json b/clients/client-apigatewayv2/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-app-mesh/package.json b/clients/client-app-mesh/package.json
@@ -63,14 +63,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-app-mesh/typedoc.json b/clients/client-app-mesh/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }
diff --git a/clients/client-appconfig/package.json b/clients/client-appconfig/package.json
@@ -61,14 +61,9 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typedoc": "0.19.2",
+    "typedoc": "0.23.23",
     "typescript": "~4.6.2"
   },
-  "overrides": {
-    "typedoc": {
-      "typescript": "~4.6.2"
-    }
-  },
   "engines": {
     "node": ">=14.0.0"
   },

diff --git a/clients/client-appconfig/typedoc.json b/clients/client-appconfig/typedoc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../typedoc.client.json"
+  "extends": ["../../typedoc.client.json"],
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "readme": "README.md"
 }