Amplify JS release

.circleci/config.yml

@@ -1522,6 +1522,23 @@ jobs:
           spec: vanilla-js-basic-crud
           amplifyjs_dir: ~/amplify-js
 
+  integ_react_datastore_docs_examples:
+    parameters:
+      browser:
+        type: string
+    executor: js-test-executor
+    <<: *test_env_vars
+    working_directory: ~/amplify-js-samples-staging/samples/react/datastore/v2/amplify-docs-examples
+    steps:
+      - prepare_test_env
+      - integ_test_js:
+          test_name: 'DataStore - Docs Examples'
+          framework: react
+          category: datastore
+          sample_name: v2/amplify-docs-examples
+          spec: amplify-docs-examples
+          browser: << parameters.browser >>
+
   deploy:
     executor: macos-executor
     working_directory: ~/amplify-js
@@ -2159,6 +2176,15 @@ workflows:
           matrix:
             parameters:
               <<: *minimal_browser_list
+      - integ_react_datastore_docs_examples:
+          requires:
+            - integ_setup
+            - build
+          filters:
+            <<: *releasable_branches
+          matrix:
+            parameters:
+              <<: *minimal_browser_list
       - deploy:
           filters:
             <<: *releasable_branches
@@ -2228,6 +2254,7 @@ workflows:
             - integ_vite_datastore_basic_crud
             - integ_rollup_datastore_basic_crud
             - integ_vanilla_js_datastore_basic_crud
+            - integ_react_datastore_docs_examples
       - post_release:
           filters:
             branches:

CONTRIBUTING.md

@@ -48,6 +48,11 @@ Our work is done directly on Github and PR's are sent to the GitHub repo by core
 
 ## Setting up for local development
 
+The recommended version of Node JS to work with this project is [`16.19.0`](https://nodejs.org/en/blog/release/v16.19.0/) with Yarn version [`1.22.x`](https://github.com/yarnpkg/yarn/blob/master/CHANGELOG.md).
+
+> Note: newer versions of Yarn (2+) remove support for lerna's `--mutex` flag
+> so be sure to use Yarn v1.22.x
+
 This section should get you running with **Amplify JS** and get you familiar with the basics of the codebase. You will need the latest version of [Node.js](https://nodejs.org/en/) on your system and developing locally also requires `yarn` workspaces. You can install it [here](https://classic.yarnpkg.com/en/docs/install#mac-stable).
 
 Start by [forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the main branch of [amplify-js](https://github.com/aws-amplify/amplify-js).

docs/api/classes/abstractconvertpredictionsprovider.html

@@ -1000,7 +1000,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
 			<aside class="tsd-sources">
 				<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#_config">_config</a></p>
 				<ul>
-					<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
+					<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
 				</ul>
 			</aside>
 		</section>
@@ -1018,7 +1018,7 @@ <h3>configure</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#configure">configure</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1041,7 +1041,7 @@ <h3>convert</h3>
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:21</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:21</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1064,7 +1064,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> convert<wbr>Speech<
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L48">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:48</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L48">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:48</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1087,7 +1087,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> convert<wbr>Text<wb
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L42">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:42</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L42">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:42</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1111,7 +1111,7 @@ <h3>get<wbr>Category</h3>
 					<aside class="tsd-sources">
 						<p>Overrides <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getcategory">getCategory</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:17</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:17</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1129,7 +1129,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Provider<wbr>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1146,7 +1146,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> translate<wbr>Text<
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L36">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:36</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L36">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:36</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>

docs/api/classes/abstractidentifypredictionsprovider.html

@@ -1000,7 +1000,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
 			<aside class="tsd-sources">
 				<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#_config">_config</a></p>
 				<ul>
-					<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
+					<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
 				</ul>
 			</aside>
 		</section>
@@ -1018,7 +1018,7 @@ <h3>configure</h3>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#configure">configure</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1042,7 +1042,7 @@ <h3>get<wbr>Category</h3>
 					<aside class="tsd-sources">
 						<p>Overrides <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getcategory">getCategory</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:17</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:17</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1060,7 +1060,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Provider<wbr>
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1077,7 +1077,7 @@ <h3>identify</h3>
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:21</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:21</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1100,7 +1100,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> identify<wbr>Entiti
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L50">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:50</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L50">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:50</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1123,7 +1123,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> identify<wbr>Labels
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L44">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:44</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L44">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:44</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1146,7 +1146,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> identify<wbr>Text</
 				<li class="tsd-description">
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/4901f556e/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L38">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:38</a></li>
+							<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/eb8b05f84/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L38">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:38</a></li>
 						</ul>
 					</aside>
 					<h4 class="tsd-parameters-title">Parameters</h4>