Updated default branch docs (manually)

Author: abrighton

esw-gateway-ui-example/flows/base-flow.html

@@ -164,7 +164,7 @@ <h2><a href="#generate-application" name="generate-application" class="anchor"><
 </code></pre>
 <p>This will generate a sample folder with <code>docs</code> and <code>src</code> folders. For a sanity check, let&rsquo;s go ahead and build the frontend created by the template. This will also help ensure you have the necessary tools installed.</p>
 <h3><a href="#compile-the-frontend" name="compile-the-frontend" class="anchor"><span class="anchor-link"></span></a>Compile the Frontend</h3>
-<p>The <code>sample/src</code> sub-folder is where your frontend application is located. It uses Typescript, React and node. Make sure node version <code>v16.0.0</code> or higher is installed in your machine. Let&rsquo;s compile our generated application.</p>
+<p>The <code>sample/src</code> sub-folder is where your frontend application is located. It uses Typescript, React and node. Make sure node version <code>v22.15.1</code> and npm 10.9.2 or higher are installed on your machine. Let&rsquo;s compile our generated application.</p>
 <pre class="prettyprint"><code class="language-bash">cd sample
 npm install
 npm start
@@ -188,7 +188,7 @@ <h3><a href="#create-login-component" name="create-login-component" class="ancho
   <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/Login.tsx#L2-L11" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">import React, { useEffect } from &#39;react&#39;
 import { useAuth } from &#39;../hooks/useAuth&#39;
 
-export const Login = (): JSX.Element =&gt; {
+export const Login = (): React.JSX.Element =&gt; {
   const { login } = useAuth()
 
   useEffect(login, [login])
@@ -205,7 +205,7 @@ <h3><a href="#update-main-app-component-with-authentication" name="update-main-a
   <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/Main.tsx#L2-L55" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">import * as React from &#39;react&#39;
 import { useAuth } from &#39;../hooks/useAuth&#39;
 import { Login } from &#39;./Login&#39;
-export const Main = (): JSX.Element =&gt; {
+export const Main = (): React.JSX.Element =&gt; {
   const { auth } = useAuth()
   if (!auth) return &lt;div&gt;Loading&lt;/div&gt;
   const isAuthenticated = auth?.isAuthenticated() ?? false
@@ -235,7 +235,7 @@ <h3><a href="#update-main-app-component-with-authentication" name="update-main-a
   LocationService,
   loadGlobalConfig
 } from &#39;@tmtsoftware/esw-ts&#39;
-const App = (): JSX.Element =&gt; {
+export const App = (): React.JSX.Element =&gt; {
   // ..
   // ..
   const { error, data: initialised } = useQuery(() =&gt;
@@ -259,7 +259,7 @@ <h3><a href="#update-main-app-component-with-authentication" name="update-main-a
 <p>After adding this section, run the following command to see the progress that we made till now.</p>
 <pre class="prettyprint"><code class="language-bash">npm start
 </code></pre>
-<p>You should now see <code>Loading...</code> on the browser screen. </p>
+<p>You should now see <code>Loading...</code> on the browser screen.</p>
 <p><img src="../images/login.png" alt="login" /></p>
 <p>This is because the UI is now trying to find the AAS authorization server, but we have not yet started CSW services. We will start them now, as well as the UI Gateway which will be needed for our subsequent flows.</p>
 <h2><a href="#starting-backend-services" name="starting-backend-services" class="anchor"><span class="anchor-link"></span></a>Starting backend services</h2>
@@ -269,7 +269,7 @@ <h2><a href="#starting-backend-services" name="starting-backend-services" class=
 </code></pre>
 <p>Start the UI Gateway Service using esw-services.</p>
 <pre class="prettyprint"><code class="language-bash">cs install esw-services
-esw-services start -g
+esw-services start start-eng-ui-services
 
 </code></pre>
 <p>Now try reloading the front end in browser. If the page is still up, refresh the page. If you closed it, restart the server using:</p>
@@ -278,8 +278,8 @@ <h2><a href="#starting-backend-services" name="starting-backend-services" class=
 <p>You should be getting redirected to keycloak login page.</p>
 <p><img src="../images/user-login.png" alt="user-login" /></p>
 <p>Try logging in with one of predefined users in csw-services.</p>
-<p>Visit <a href="https://tmtsoftware.github.io/csw/0.1.0-SNAPSHOT/apps/cswservices.html#predefined-users-">here</a> to find the predefined users.</p>
-<p>Visit <a href="https://tmtsoftware.github.io/esw/0.1.0-SNAPSHOT/uisupport/gateway.html">here</a> to know more about users &amp; the roles.</p>
+<p>Visit <a href="https://tmtsoftware.github.io/csw/6.0.0/apps/cswservices.html#predefined-users-">here</a> to find the predefined users.</p>
+<p>Visit <a href="https://tmtsoftware.github.io/esw/1.0.2/uisupport/gateway.html">here</a> to know more about users &amp; the roles.</p>
 <p>Once you are logged in, you would be greeted again with <code>Hello world</code>.</p>
 <p>Now, we can make use of authorization data to send a request to a protected route of the Gateway server.</p>
 <h3><a href="#cleanup" name="cleanup" class="anchor"><span class="anchor-link"></span></a>Cleanup</h3>

esw-gateway-ui-example/flows/submit-commands.html

@@ -156,15 +156,15 @@
 <div class="md-content__searchable">
 <h1><a href="#adding-a-submit-command" name="adding-a-submit-command" class="anchor"><span class="anchor-link"></span></a>Adding a Submit Command</h1>
 <p>In this part of the tutorial, we want to send a Setup Command to an Assembly from the UI application via Gateway server.</p>
-<p>Visit <a href="https://tmtsoftware.github.io/csw/0.1.0-SNAPSHOT/params/commands.html">here</a> to learn more about commands.</p>
-<p>Visit <a href="https://tmtsoftware.github.io/csw/0.1.0-SNAPSHOT/commons/create-component.html">here</a> to learn more about components.</p>
+<p>Visit <a href="https://tmtsoftware.github.io/csw/6.0.0/params/commands.html">here</a> to learn more about commands.</p>
+<p>Visit <a href="https://tmtsoftware.github.io/csw/6.0.0/commons/create-component.html">here</a> to learn more about components.</p>
 <h2><a href="#start-an-assembly-using-esw-shell" name="start-an-assembly-using-esw-shell" class="anchor"><span class="anchor-link"></span></a>Start an Assembly using esw-shell</h2>
-<p>We will use the esw-shell utility to create and start a simple Assembly. The esw-shell is a REPL application that provides numerous tools for TMT programming. Visit <a href="https://tmtsoftware.github.io/esw/0.1.0-SNAPSHOT/eswshell/esw-shell.html">here</a> to learn more about the esw-shell utility.</p>
+<p>We will use the esw-shell utility to create and start a simple Assembly. The esw-shell is a REPL application that provides numerous tools for TMT programming. Visit <a href="https://tmtsoftware.github.io/esw/1.0.2/eswshell/esw-shell.html">here</a> to learn more about the esw-shell utility.</p>
 <pre class="prettyprint"><code class="language-bash">cs install esw-shell
 esw-shell start
 @                 // you are inside ammonite repl now
 </code></pre>
-<p>We will use an esw-shell <a href="https://tmtsoftware.github.io/esw/0.1.0-SNAPSHOT/technical/apps/esw-shell.html#using-custom-component-handlers">feature</a> that allows the dynamic creation of component by specifying command handler functionality when spawning the component.</p>
+<p>We will use an esw-shell <a href="https://tmtsoftware.github.io/esw/1.0.2/technical/apps/esw-shell.html#using-custom-component-handlers">feature</a> that allows the dynamic creation of component by specifying command handler functionality when spawning the component.</p>
 <p>Our assembly will take a <code>sleep</code> command with <code>sleepInSeconds</code> (LongKey) parameter. This is a long-running command which will return a <code>Started</code> response immediately and then a <code>Completed</code> response after sleeping the time provided in the parameter. Any other command other than <code>sleep</code> immediately returns a <code>Completed</code> response.</p>
 <p>Run this command inside esw-shell&rsquo;s ammonite shell:</p>
 <pre class="prettyprint"><code class="language-bash">spawnAssemblyWithHandler(
@@ -194,7 +194,7 @@ <h2><a href="#add-submit-command-component" name="add-submit-command-component"
 <dl>
   <dt>Typescript</dt>
   <dd>
-  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/SubmitCommand.tsx#L2-L179" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">import {
+  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/SubmitCommand.tsx#L2-L178" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">import {
   CommandService,
   ComponentId,
   longKey,
@@ -237,7 +237,7 @@ <h2><a href="#add-submit-command-component" name="add-submit-command-component"
   _commandService
 }: {
   _commandService?: CommandService
-}): JSX.Element =&gt; {
+}): React.JSX.Element =&gt; {
   const { auth } = useAuth()
   const authData = { tokenFactory: () =&gt; auth?.token() }
 
@@ -272,8 +272,7 @@ <h2><a href="#add-submit-command-component" name="add-submit-command-component"
       switch (result._type) {
         case &#39;Started&#39;:
           setResult(result)
-          const res = await commandService.queryFinal(result.runId, 5)
-          setResult(res)
+          setResult(await commandService.queryFinal(result.runId, 5))
           break
         default:
           setResult(result)
@@ -391,7 +390,7 @@ <h2><a href="#add-submit-command-component" name="add-submit-command-component"
 <dl>
   <dt>Typescript</dt>
   <dd>
-  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/SubmitCommand.tsx#L63-L95" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">const submit = async () =&gt; {
+  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/SubmitCommand.tsx#L63-L94" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">const submit = async () =&gt; {
   try {
     const sleepInMs = longKey(&#39;sleepInSeconds&#39;).set([
       sleepTime ? sleepTime : 0
@@ -413,8 +412,7 @@ <h2><a href="#add-submit-command-component" name="add-submit-command-component"
     switch (result._type) {
       case &#39;Started&#39;:
         setResult(result)
-        const res = await commandService.queryFinal(result.runId, 5)
-        setResult(res)
+        setResult(await commandService.queryFinal(result.runId, 5))
         break
       default:
         setResult(result)
@@ -429,7 +427,7 @@ <h2><a href="#add-submit-command-component" name="add-submit-command-component"
 <dl>
   <dt>Typescript</dt>
   <dd>
-  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/SubmitCommand.tsx#L165-L174" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">&lt;Typography.Title level={2}&gt;Result&lt;/Typography.Title&gt;
+  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/SubmitCommand.tsx#L164-L173" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">&lt;Typography.Title level={2}&gt;Result&lt;/Typography.Title&gt;
 &lt;Typography.Paragraph&gt;
   {result &amp;&amp; (
     &lt;Badge.Ribbon
@@ -465,7 +463,7 @@ <h2><a href="#integrate-submitcommand-component" name="integrate-submitcommand-c
 <dl>
   <dt>Typescript</dt>
   <dd>
-  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/Main.tsx#L11-L32" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">export const Main = (): JSX.Element =&gt; {
+  <pre class="prettyprint"><button class="snippet-button copy-snippet" title="Copy snippet to clipboard">copy</button><a class="snippet-button go-to-source" href="https://github.com/tmtsoftware/esw-gateway-ui-example/tree/master/src/components/Main.tsx#L11-L32" target="_blank" title="Go to snippet source">source</a><code class="language-tsx">export const Main = (): React.JSX.Element =&gt; {
   const { auth } = useAuth()
   if (!auth) return &lt;div&gt;Loading&lt;/div&gt;
   const isAuthenticated = auth?.isAuthenticated() ?? false