chore(release): Update API docs [skip release]

aws-amplify · Nov 20, 2024 · 20798fb · 20798fb
1 parent 30abdbd
commit 20798fb
Show file tree

Hide file tree

Showing 43 changed files with 108 additions and 52 deletions.
diff --git a/docs/api/assets/navigation.js b/docs/api/assets/navigation.js
diff --git a/docs/api/assets/search.js b/docs/api/assets/search.js
diff --git a/docs/api/enums/aws_amplify.datastore._Reference_Types_.StorageAction.html b/docs/api/enums/aws_amplify.datastore._Reference_Types_.StorageAction.html
diff --git a/.../interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.AuthIdentityPoolConfig.html b/.../interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.AuthIdentityPoolConfig.html
diff --git a/docs/api/interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.BucketInfo.html b/docs/api/interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.BucketInfo.html
diff --git a/...i/interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.CognitoUserPoolConfig.html b/...i/interfaces/_aws_amplify_adapter_nextjs.api._Reference_Types_.CognitoUserPoolConfig.html
diff --git a/...ces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AmplifyOutputsAuthProperties.html b/...ces/_aws_amplify_adapter_nextjs.index._Reference_Types_.AmplifyOutputsAuthProperties.html
diff --git a/...amplify_adapter_nextjs.index._Reference_Types_.AmplifyOutputsStorageBucketProperties.html b/...amplify_adapter_nextjs.index._Reference_Types_.AmplifyOutputsStorageBucketProperties.html
diff --git a/...i/interfaces/aws_amplify.adapter_core._Reference_Types_.AmplifyOutputsAuthProperties.html b/...i/interfaces/aws_amplify.adapter_core._Reference_Types_.AmplifyOutputsAuthProperties.html
diff --git a/...ces/aws_amplify.adapter_core._Reference_Types_.AmplifyOutputsStorageBucketProperties.html b/...ces/aws_amplify.adapter_core._Reference_Types_.AmplifyOutputsStorageBucketProperties.html
diff --git a/docs/api/interfaces/aws_amplify.adapter_core._Reference_Types_.AuthIdentityPoolConfig.html b/docs/api/interfaces/aws_amplify.adapter_core._Reference_Types_.AuthIdentityPoolConfig.html
diff --git a/docs/api/interfaces/aws_amplify.adapter_core._Reference_Types_.CognitoUserPoolConfig.html b/docs/api/interfaces/aws_amplify.adapter_core._Reference_Types_.CognitoUserPoolConfig.html
diff --git a/docs/api/interfaces/aws_amplify.index._Reference_Types_.BucketInfo.html b/docs/api/interfaces/aws_amplify.index._Reference_Types_.BucketInfo.html
diff --git a/docs/api/interfaces/aws_amplify.storage._Reference_Types_.BucketInfo.html b/docs/api/interfaces/aws_amplify.storage._Reference_Types_.BucketInfo.html
diff --git a/docs/api/interfaces/aws_amplify.storage._Reference_Types_.CommonOptions.html b/docs/api/interfaces/aws_amplify.storage._Reference_Types_.CommonOptions.html
diff --git a/...terfaces/aws_amplify.storage_server._Reference_Types_.CopyWithPathDestinationOptions.html b/...terfaces/aws_amplify.storage_server._Reference_Types_.CopyWithPathDestinationOptions.html
diff --git a/...pi/interfaces/aws_amplify.storage_server._Reference_Types_.CopyWithPathSourceOptions.html b/...pi/interfaces/aws_amplify.storage_server._Reference_Types_.CopyWithPathSourceOptions.html
diff --git a/...api/interfaces/aws_amplify.storage_server._Reference_Types_.StorageCopyInputWithPath.html b/...api/interfaces/aws_amplify.storage_server._Reference_Types_.StorageCopyInputWithPath.html
diff --git a/docs/api/modules/_aws_amplify_adapter_nextjs.api._Reference_Types_.html b/docs/api/modules/_aws_amplify_adapter_nextjs.api._Reference_Types_.html
@@ -203,6 +203,7 @@
 <a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.TypeSystemExtensionNode.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Type<wbr/>System<wbr/>Extension<wbr/>Node</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.UnionKeys.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Union<wbr/>Keys</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.UnknownGraphQLResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Unknown<wbr/>GraphQLResponse</span></a>
+<a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.UserGroupPrecedence.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>User<wbr/>Group<wbr/>Precedence</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.V6ClientSSRCookies.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>V6<wbr/>ClientSSRCookies</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.V6ClientSSRRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>V6<wbr/>ClientSSRRequest</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.api._Reference_Types_.ValueNode.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Value<wbr/>Node</span></a>

diff --git a/docs/api/modules/_aws_amplify_adapter_nextjs.html b/docs/api/modules/_aws_amplify_adapter_nextjs.html
@@ -1,5 +1,5 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@aws-amplify/adapter-nextjs - v1.2.28 | Amplify JS API Documentation</title><meta name="description" content="Documentation for Amplify JS API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
-</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="_aws_amplify_adapter_nextjs.html">@aws-amplify/adapter-nextjs</a></li></ul><h1>Module @aws-amplify/adapter-nextjs - v1.2.28</h1></div><section class="tsd-panel tsd-typography"><p>This package contains the AWS Amplify Next.js Adapter. For more information on using Next.js in your application please reference the <a href="https://docs.amplify.aws/javascript/build-a-backend/server-side-rendering/nextjs/">Amplify Dev Center</a>.</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@aws-amplify/adapter-nextjs - v1.2.29 | Amplify JS API Documentation</title><meta name="description" content="Documentation for Amplify JS API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
+</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="_aws_amplify_adapter_nextjs.html">@aws-amplify/adapter-nextjs</a></li></ul><h1>Module @aws-amplify/adapter-nextjs - v1.2.29</h1></div><section class="tsd-panel tsd-typography"><p>This package contains the AWS Amplify Next.js Adapter. For more information on using Next.js in your application please reference the <a href="https://docs.amplify.aws/javascript/build-a-backend/server-side-rendering/nextjs/">Amplify Dev Center</a>.</p>
 </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Modules</h3><div class="tsd-index-list"><a href="_aws_amplify_adapter_nextjs.api.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg><span>api</span></a>
 <a href="_aws_amplify_adapter_nextjs.index.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg><span>index</span></a>
 <a href="_aws_amplify_adapter_nextjs.utils.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg><span>utils</span></a>

diff --git a/docs/api/modules/_aws_amplify_adapter_nextjs.index._Reference_Types_.html b/docs/api/modules/_aws_amplify_adapter_nextjs.index._Reference_Types_.html
@@ -163,6 +163,7 @@
 <a href="../types/_aws_amplify_adapter_nextjs.index._Reference_Types_.SocketConnectOpts.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Socket<wbr/>Connect<wbr/>Opts</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.index._Reference_Types_.SocketReadyState.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Socket<wbr/>Ready<wbr/>State</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.index._Reference_Types_.TypedArray.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Typed<wbr/>Array</span></a>
+<a href="../types/_aws_amplify_adapter_nextjs.index._Reference_Types_.UserGroupPrecedence.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>User<wbr/>Group<wbr/>Precedence</span></a>
 <a href="../types/_aws_amplify_adapter_nextjs.index._Reference_Types_.XMLHttpRequestBodyInit.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>XMLHttp<wbr/>Request<wbr/>Body<wbr/>Init</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_aws_amplify_adapter_nextjs.index._Reference_Types_.Error-1.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Error</span></a>
 <a href="../variables/_aws_amplify_adapter_nextjs.index._Reference_Types_.Object-1.html" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Object</span></a>

diff --git a/docs/api/modules/_aws_amplify_datastore_storage_adapter.html b/docs/api/modules/_aws_amplify_datastore_storage_adapter.html
@@ -1,5 +1,5 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@aws-amplify/datastore-storage-adapter - v2.1.60 | Amplify JS API Documentation</title><meta name="description" content="Documentation for Amplify JS API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
-</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="_aws_amplify_datastore_storage_adapter.html">@aws-amplify/datastore-storage-adapter</a></li></ul><h1>Module @aws-amplify/datastore-storage-adapter - v2.1.60</h1></div><section class="tsd-panel tsd-typography"><p>This package contains the AWS Amplify DataStore storage adapter. For more information on using the DataStore storage adapter in your application please reference the <a href="https://docs.amplify.aws/react-native/build-a-backend/more-features/datastore/set-up-datastore/#setup-local-development-environment">Amplify Dev Center</a>.</p>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@aws-amplify/datastore-storage-adapter - v2.1.61 | Amplify JS API Documentation</title><meta name="description" content="Documentation for Amplify JS API Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../favicon.ico" />
+</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.amplify.aws/">Library Documentation</a><a href="https://www.npmjs.com/package/aws-amplify">NPM</a><a href="https://github.com/aws-amplify/amplify-js">GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify JS API Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify JS API Documentation</a></li><li><a href="_aws_amplify_datastore_storage_adapter.html">@aws-amplify/datastore-storage-adapter</a></li></ul><h1>Module @aws-amplify/datastore-storage-adapter - v2.1.61</h1></div><section class="tsd-panel tsd-typography"><p>This package contains the AWS Amplify DataStore storage adapter. For more information on using the DataStore storage adapter in your application please reference the <a href="https://docs.amplify.aws/react-native/build-a-backend/more-features/datastore/set-up-datastore/#setup-local-development-environment">Amplify Dev Center</a>.</p>
 </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Modules</h3><div class="tsd-index-list"><a href="_aws_amplify_datastore_storage_adapter.ExpoSQLiteAdapter_ExpoSQLiteAdapter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg><span>ExpoSQLite<wbr/>Adapter/<wbr/>ExpoSQLite<wbr/>Adapter</span></a>
 <a href="_aws_amplify_datastore_storage_adapter.SQLiteAdapter_SQLiteAdapter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg><span>SQLite<wbr/>Adapter/SQLite<wbr/>Adapter</span></a>
 <a href="_aws_amplify_datastore_storage_adapter.index.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg><span>index</span></a>