@aws/nx-plugin 0.3.0 → 0.4.0

package/LICENSE-THIRD-PARTY

@@ -2948,12 +2948,12 @@ SOFTWARE.
 
 ---
 
-The following software may be included in this product: @esbuild/linux-x64 (0.21.5)
+The following software may be included in this product: @esbuild/darwin-arm64 (0.21.5)
 This software contains the following license and notice below:
 
 MIT License
 
-Copyright (c) The maintainers of @esbuild/linux-x64 <https://github.com/evanw/esbuild#readme>
+Copyright (c) The maintainers of @esbuild/darwin-arm64 <https://github.com/evanw/esbuild#readme>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
@@ -2963,12 +2963,12 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ---
 
-The following software may be included in this product: @esbuild/linux-x64 (0.24.0)
+The following software may be included in this product: @esbuild/darwin-arm64 (0.24.0)
 This software contains the following license and notice below:
 
 MIT License
 
-Copyright (c) The maintainers of @esbuild/linux-x64 <https://github.com/evanw/esbuild#readme>
+Copyright (c) The maintainers of @esbuild/darwin-arm64 <https://github.com/evanw/esbuild#readme>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
@@ -4095,27 +4095,12 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ---
 
-The following software may be included in this product: @nx/nx-linux-x64-gnu (20.4.0)
+The following software may be included in this product: @nx/nx-darwin-arm64 (20.4.0)
 This software contains the following license and notice below:
 
 MIT License
 
-Copyright (c) The maintainers of @nx/nx-linux-x64-gnu <https://github.com/nrwl/nx#readme>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----
-
-The following software may be included in this product: @nx/nx-linux-x64-musl (20.4.0)
-This software contains the following license and notice below:
-
-MIT License
-
-Copyright (c) The maintainers of @nx/nx-linux-x64-musl <https://github.com/nrwl/nx#readme>
+Copyright (c) The maintainers of @nx/nx-darwin-arm64 <https://github.com/nrwl/nx#readme>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
@@ -4513,22 +4498,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ---
 
-The following software may be included in this product: @rollup/rollup-linux-x64-gnu (4.22.5)
-This software contains the following license and notice below:
-
-MIT License
-
-Copyright (c) Lukas Taegert-Atkinson
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----
-
-The following software may be included in this product: @rollup/rollup-linux-x64-musl (4.22.5)
+The following software may be included in this product: @rollup/rollup-darwin-arm64 (4.22.5)
 This software contains the following license and notice below:
 
 MIT License
@@ -4571,34 +4541,7 @@ SOFTWARE.
 
 ---
 
-The following software may be included in this product: @rspack/binding-linux-x64-gnu (1.1.8)
-This software contains the following license and notice below:
-
-MIT License
-
-Copyright (c) 2022-present Bytedance Inc and its affiliates.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
----
-
-The following software may be included in this product: @rspack/binding-linux-x64-musl (1.1.8)
+The following software may be included in this product: @rspack/binding-darwin-arm64 (1.1.8)
 This software contains the following license and notice below:
 
 MIT License
@@ -11426,6 +11369,34 @@ OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHE
 
 ---
 
+The following software may be included in this product: fsevents (2.3.3)
+This software contains the following license and notice below:
+
+MIT License
+-----------
+
+Copyright (C) 2010-2020 by Philipp Dunkel, Ben Noordhuis, Elan Shankar, Paul Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---
+
 The following software may be included in this product: function-bind (1.1.2)
 This software contains the following license and notice below:
 
@@ -38382,6 +38353,25 @@ END OF TERMS AND CONDITIONS
 
 ---
 
+The following software may be included in this product: @iarna/toml (2.2.5)
+This software contains the following license and notice below:
+
+Copyright (c) 2016, Rebecca Turner <me@re-becca.org>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---
+
 The following software may be included in this product: @isaacs/cliui (8.0.2)
 This software contains the following license and notice below:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws/nx-plugin",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "private": false,
   "type": "commonjs",
   "license": "Apache-2.0",
@@ -15,6 +15,7 @@
     "nx": "20.4.0"
   },
   "dependencies": {
+    "@iarna/toml": "^2.2.5",
     "@nx/devkit": "^20.4.0",
     "@nx/eslint": "^20.4.0",
     "@nx/js": "^20.4.0",

package/src/cloudscape-website/app/README.md

@@ -233,7 +233,7 @@ import RuntimeConfigProvider from './components/RuntimeConfig';
 
 const App = () => (
   <RuntimeConfigProvider>
-    <BrowserRouter>{/* Your app components */}</BrowserRouter>
+    <RouterProvider router={router} />
   </RuntimeConfigProvider>
 );
 ```

package/src/cloudscape-website/app/__snapshots__/generator.spec.ts.snap

@@ -21,7 +21,8 @@ exports[`cloudscape-website generator > should configure TypeScript correctly >
 `;
 
 exports[`cloudscape-website generator > should configure vite correctly > vite.config.ts 1`] = `
-"/// <reference types='vitest' />
+"import { TanStackRouterVite } from '@tanstack/router-plugin/vite';
+/// <reference types='vitest' />
 import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
 import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
@@ -40,7 +41,12 @@ export default defineConfig({
     port: 4300,
     host: 'localhost',
   },
-  plugins: [react(), nxViteTsPaths(), nxCopyAssetsPlugin(['*.md'])],
+  plugins: [
+    react(),
+    nxViteTsPaths(),
+    nxCopyAssetsPlugin(['*.md']),
+    TanStackRouterVite(),
+  ],
   build: {
     outDir: '../dist/test-app',
     emptyOutDir: true,
@@ -70,7 +76,6 @@ exports[`cloudscape-website generator > should generate base files and structure
 import { createContext, useCallback, useEffect, useState } from 'react';
 import { NavItems } from './navitems';
 import Config from '../../config';
-import Routes from '../Routes';
 
 import {
   BreadcrumbGroup,
@@ -78,10 +83,11 @@ import {
   SideNavigation,
   TopNavigation,
 } from '@cloudscape-design/components';
-import AppLayout, {
+import CloudscapeAppLayout, {
   AppLayoutProps,
 } from '@cloudscape-design/components/app-layout';
-import { matchPath, useLocation, useNavigate } from 'react-router-dom';
+import { matchByPath, useLocation, useNavigate } from '@tanstack/react-router';
+import { Outlet } from '@tanstack/react-router';
 
 const getBreadcrumbs = (
   pathName: string,
@@ -104,7 +110,7 @@ const getBreadcrumbs = (
             .replace('//', '/')}\`;
 
     const matched =
-      !availableRoutes || availableRoutes.find((r) => matchPath(r, href));
+      !availableRoutes || availableRoutes.find((r) => matchByPath(r, href, {}));
 
     return {
       href: matched ? \`\${href}\${search}\` : '#',
@@ -113,6 +119,12 @@ const getBreadcrumbs = (
   });
 };
 
+export interface AppLayoutContext {
+  appLayoutProps: AppLayoutProps;
+  setAppLayoutProps: (props: AppLayoutProps) => void;
+  displayHelpPanel: (helpContent: React.ReactNode) => void;
+}
+
 /**
  * Context for updating/retrieving the AppLayout.
  */
@@ -120,19 +132,21 @@ export const AppLayoutContext = createContext({
   appLayoutProps: {},
   // eslint-disable-next-line @typescript-eslint/no-empty-function
   setAppLayoutProps: (_: AppLayoutProps) => {},
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  displayHelpPanel: (_: React.ReactNode) => {},
 });
 
 /**
  * Defines the App layout and contains logic for routing.
  */
-const App: React.FC = () => {
+const AppLayout: React.FC = () => {
   const navigate = useNavigate();
-  const [activeHref, setActiveHref] = useState('/');
+  const appLayout = React.useRef<AppLayoutProps.Ref>(null);
   const [activeBreadcrumbs, setActiveBreadcrumbs] = useState<
     BreadcrumbGroupProps.Item[]
   >([{ text: '/', href: '/' }]);
   const [appLayoutProps, setAppLayoutProps] = useState<AppLayoutProps>({});
-  const location = useLocation();
+  const { pathname, search } = useLocation();
 
   const setAppLayoutPropsSafe = useCallback(
     (props: AppLayoutProps) => {
@@ -143,10 +157,13 @@ const App: React.FC = () => {
   );
 
   useEffect(() => {
-    setActiveHref(location.pathname);
-    const breadcrumbs = getBreadcrumbs(location.pathname, location.search, '/');
+    const breadcrumbs = getBreadcrumbs(
+      pathname,
+      Object.entries(search).reduce((p, [k, v]) => p + \`\${k}=\${v}\`, ''),
+      '/',
+    );
     setActiveBreadcrumbs(breadcrumbs);
-  }, [location]);
+  }, [pathname, search]);
 
   const onNavigate = useCallback(
     (e: CustomEvent<{ href: string; external?: boolean }>) => {
@@ -155,7 +172,7 @@ const App: React.FC = () => {
         setAppLayoutPropsSafe({
           contentType: undefined,
         });
-        navigate(e.detail.href);
+        navigate({ to: e.detail.href });
       }
     },
     [navigate, setAppLayoutPropsSafe],
@@ -163,7 +180,14 @@ const App: React.FC = () => {
 
   return (
     <AppLayoutContext.Provider
-      value={{ appLayoutProps, setAppLayoutProps: setAppLayoutPropsSafe }}
+      value={{
+        appLayoutProps,
+        setAppLayoutProps: setAppLayoutPropsSafe,
+        displayHelpPanel: (helpContent: React.ReactNode) => {
+          setAppLayoutPropsSafe({ tools: helpContent, toolsHide: false });
+          appLayout.current?.openTools();
+        },
+      }}
     >
       <TopNavigation
         identity={{
@@ -174,7 +198,8 @@ const App: React.FC = () => {
           },
         }}
       />
-      <AppLayout
+      <CloudscapeAppLayout
+        ref={appLayout}
         breadcrumbs={
           <BreadcrumbGroup onFollow={onNavigate} items={activeBreadcrumbs} />
         }
@@ -182,19 +207,19 @@ const App: React.FC = () => {
         navigation={
           <SideNavigation
             header={{ text: Config.applicationName, href: '/' }}
-            activeHref={activeHref}
+            activeHref={pathname}
             onFollow={onNavigate}
             items={NavItems}
           />
         }
-        content={<Routes />}
+        content={<Outlet />}
         {...appLayoutProps}
       />
     </AppLayoutContext.Provider>
   );
 };
 
-export default App;
+export default AppLayout;
 "
 `;
 
@@ -209,27 +234,59 @@ exports[`cloudscape-website generator > should generate base files and structure
 exports[`cloudscape-website generator > should generate base files and structure > main.tsx 1`] = `
 "import React from 'react';
 import { createRoot } from 'react-dom/client';
-import { BrowserRouter } from 'react-router-dom';
 import { I18nProvider } from '@cloudscape-design/components/i18n';
 import messages from '@cloudscape-design/components/i18n/messages/all.en';
-import App from './layouts/App';
+import { RouterProvider, createRouter } from '@tanstack/react-router';
+import { routeTree } from './routeTree.gen';
 
 import '@cloudscape-design/global-styles/index.css';
 
+const router = createRouter({ routeTree });
+
+// Register the router instance for type safety
+declare module '@tanstack/react-router' {
+  interface Register {
+    router: typeof router;
+  }
+}
+
 const root = document.getElementById('root');
 root &&
   createRoot(root).render(
     <React.StrictMode>
       <I18nProvider locale="en" messages={[messages]}>
-        <BrowserRouter>
-          <App />
-        </BrowserRouter>
+        <RouterProvider router={router} />
       </I18nProvider>
     </React.StrictMode>,
   );
 "
 `;
 
+exports[`cloudscape-website generator > should generate base files and structure > welcome-index.tsx 1`] = `
+"import {
+  ContentLayout,
+  Header,
+  SpaceBetween,
+  Container,
+} from '@cloudscape-design/components';
+import { createFileRoute } from '@tanstack/react-router';
+
+export const Route = createFileRoute('/welcome/')({
+  component: RouteComponent,
+});
+
+function RouteComponent() {
+  return (
+    <ContentLayout header={<Header>Welcome</Header>}>
+      <SpaceBetween size="l">
+        <Container>Welcome to your new Cloudscape website!</Container>
+      </SpaceBetween>
+    </ContentLayout>
+  );
+}
+"
+`;
+
 exports[`cloudscape-website generator > should generate shared constructs > common/constructs-app-index.ts 1`] = `
 "export * from './test-app.js';
 "
@@ -463,21 +520,28 @@ export class TestApp extends StaticWebsite {
 exports[`cloudscape-website generator > should handle custom directory option > custom-dir-main.tsx 1`] = `
 "import React from 'react';
 import { createRoot } from 'react-dom/client';
-import { BrowserRouter } from 'react-router-dom';
 import { I18nProvider } from '@cloudscape-design/components/i18n';
 import messages from '@cloudscape-design/components/i18n/messages/all.en';
-import App from './layouts/App';
+import { RouterProvider, createRouter } from '@tanstack/react-router';
+import { routeTree } from './routeTree.gen';
 
 import '@cloudscape-design/global-styles/index.css';
 
+const router = createRouter({ routeTree });
+
+// Register the router instance for type safety
+declare module '@tanstack/react-router' {
+  interface Register {
+    router: typeof router;
+  }
+}
+
 const root = document.getElementById('root');
 root &&
   createRoot(root).render(
     <React.StrictMode>
       <I18nProvider locale="en" messages={[messages]}>
-        <BrowserRouter>
-          <App />
-        </BrowserRouter>
+        <RouterProvider router={router} />
       </I18nProvider>
     </React.StrictMode>,
   );
@@ -489,10 +553,10 @@ exports[`cloudscape-website generator > should handle npm scope prefix correctly
   "@cloudscape-design/board-components": "^3.0.84",
   "@cloudscape-design/components": "^3.0.823",
   "@cloudscape-design/global-styles": "^1.0.34",
+  "@tanstack/react-router": "^1.99.7",
   "aws-cdk-lib": "^2.166.0",
   "constructs": "^10.4.2",
   "react": "18.3.1",
   "react-dom": "18.3.1",
-  "react-router-dom": "^7.1.1",
 }
 `;

package/src/cloudscape-website/app/files/app/README.md.template

@@ -33,10 +33,12 @@ You can also automatically fix some lint errors by running the following command
 
 In order to integrate with cognito or trpc backends, you need to have a `runtime-config.json` file in your `/public` website directory. You can fetch this is follows:
 
-`AWS_REGION=ap-southeast-2 CDK_APP_DIR=./dist/packages/infra/cdk.out nx run <%= fullyQualifiedName %>:load:runtime-config`
+`<%= pkgMgrCmd %> nx run <%= fullyQualifiedName %>:load:runtime-config`
 
 > [!IMPORTANT]
-> Ensure you have deployed your infrastructure first before executing this command.
+> Ensure you have AWS CLI and curl installed
+> You have deployed your CDK infrastructure into the appropriate account
+> You have assumed a role in the AWS account with sufficient permissions to call describe-stacks from cloudformation
 
 ## Useful links
 

package/src/cloudscape-website/app/files/app/src/{layouts/App → components/AppLayout}/index.tsx.template

@@ -2,7 +2,6 @@ import * as React from 'react';
 import { createContext, useCallback, useEffect, useState } from 'react';
 import { NavItems } from './navitems';
 import Config from '../../config';
-import Routes from '../Routes';
 
 import {
   BreadcrumbGroup,
@@ -10,16 +9,17 @@ import {
   SideNavigation,
   TopNavigation,
 } from '@cloudscape-design/components';
-import AppLayout, {
+import CloudscapeAppLayout, {
   AppLayoutProps,
 } from '@cloudscape-design/components/app-layout';
-import { matchPath, useLocation, useNavigate } from 'react-router-dom';
+import { matchByPath, useLocation, useNavigate } from '@tanstack/react-router';
+import { Outlet } from '@tanstack/react-router';
 
 const getBreadcrumbs = (
   pathName: string,
   search: string,
   defaultBreadcrumb: string,
-  availableRoutes?: string[]
+  availableRoutes?: string[],
 ) => {
   const segments = [
     defaultBreadcrumb,
@@ -36,7 +36,7 @@ const getBreadcrumbs = (
             .replace('//', '/')}`;
 
     const matched =
-      !availableRoutes || availableRoutes.find((r) => matchPath(r, href));
+      !availableRoutes || availableRoutes.find((r) => matchByPath(r, href, {}));
 
     return {
       href: matched ? `${href}${search}` : '#',
@@ -45,6 +45,12 @@ const getBreadcrumbs = (
   });
 };
 
+export interface AppLayoutContext {
+  appLayoutProps: AppLayoutProps;
+  setAppLayoutProps: (props: AppLayoutProps) => void;
+  displayHelpPanel: (helpContent: React.ReactNode) => void;
+}
+
 /**
  * Context for updating/retrieving the AppLayout.
  */
@@ -52,33 +58,38 @@ export const AppLayoutContext = createContext({
   appLayoutProps: {},
   // eslint-disable-next-line @typescript-eslint/no-empty-function
   setAppLayoutProps: (_: AppLayoutProps) => {},
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  displayHelpPanel: (_: React.ReactNode) => {},
 });
 
 /**
  * Defines the App layout and contains logic for routing.
  */
-const App: React.FC = () => {
+const AppLayout: React.FC = () => {
   const navigate = useNavigate();
-  const [activeHref, setActiveHref] = useState('/');
+  const appLayout = React.useRef<AppLayoutProps.Ref>(null);
   const [activeBreadcrumbs, setActiveBreadcrumbs] = useState<
     BreadcrumbGroupProps.Item[]
   >([{ text: '/', href: '/' }]);
   const [appLayoutProps, setAppLayoutProps] = useState<AppLayoutProps>({});
-  const location = useLocation();
+  const { pathname, search } = useLocation();
 
   const setAppLayoutPropsSafe = useCallback(
     (props: AppLayoutProps) => {
       JSON.stringify(appLayoutProps) !== JSON.stringify(props) &&
         setAppLayoutProps(props);
     },
-    [appLayoutProps]
+    [appLayoutProps],
   );
 
   useEffect(() => {
-    setActiveHref(location.pathname);
-    const breadcrumbs = getBreadcrumbs(location.pathname, location.search, '/');
+    const breadcrumbs = getBreadcrumbs(
+      pathname,
+      Object.entries(search).reduce((p, [k, v]) => p + `${k}=${v}`, ''),
+      '/',
+    );
     setActiveBreadcrumbs(breadcrumbs);
-  }, [location]);
+  }, [pathname, search]);
 
   const onNavigate = useCallback(
     (e: CustomEvent<{ href: string; external?: boolean }>) => {
@@ -87,15 +98,22 @@ const App: React.FC = () => {
         setAppLayoutPropsSafe({
           contentType: undefined,
         });
-        navigate(e.detail.href);
+        navigate({ to: e.detail.href });
       }
     },
-    [navigate, setAppLayoutPropsSafe]
+    [navigate, setAppLayoutPropsSafe],
   );
 
   return (
     <AppLayoutContext.Provider
-      value={{ appLayoutProps, setAppLayoutProps: setAppLayoutPropsSafe }}
+      value={{
+        appLayoutProps,
+        setAppLayoutProps: setAppLayoutPropsSafe,
+        displayHelpPanel: (helpContent: React.ReactNode) => {
+          setAppLayoutPropsSafe({ tools: helpContent, toolsHide: false });
+          appLayout.current?.openTools();
+        },
+      }}
     >
       <TopNavigation
         identity={{
@@ -106,7 +124,8 @@ const App: React.FC = () => {
           },
         }}
       />
-      <AppLayout
+      <CloudscapeAppLayout
+        ref={appLayout}
         breadcrumbs={
           <BreadcrumbGroup onFollow={onNavigate} items={activeBreadcrumbs} />
         }
@@ -114,16 +133,16 @@ const App: React.FC = () => {
         navigation={
           <SideNavigation
             header={{ text: Config.applicationName, href: '/' }}
-            activeHref={activeHref}
+            activeHref={pathname}
             onFollow={onNavigate}
             items={NavItems}
           />
         }
-        content={<Routes />}
+        content={<Outlet />}
         {...appLayoutProps}
       />
     </AppLayoutContext.Provider>
   );
 };
 
-export default App;
+export default AppLayout;

package/src/cloudscape-website/app/files/app/src/{layouts/App → components/AppLayout}/navitems.ts.template

@@ -4,5 +4,5 @@ import { SideNavigationProps } from '@cloudscape-design/components';
  * Define your Navigation Items here
  */
 export const NavItems: SideNavigationProps.Item[] = [
-  { text: 'Home', type: 'link', href: '/' },
+  { text: 'Welcome', type: 'link', href: '/welcome' },
 ];

package/src/cloudscape-website/app/files/app/src/hooks/useAppLayout.tsx.template

@@ -0,0 +1,5 @@
+import { useContext } from 'react';
+import { AppLayoutContext } from '../components/AppLayout';
+
+export const useAppLayout = (): AppLayoutContext =>
+  useContext(AppLayoutContext);