expose route/location info to the assistant

catalog/app/components/Assistant/Model/Assistant.tsx

@@ -9,6 +9,7 @@ import * as Actor from 'utils/Actor'
 import * as Bedrock from './Bedrock'
 import * as Context from './Context'
 import * as Conversation from './Conversation'
+import * as GlobalContext from './GlobalContext'
 import * as GlobalTools from './GlobalTools'
 
 function usePassThru<T>(val: T) {
@@ -36,6 +37,7 @@ function useConstructAssistantAPI() {
 
   Context.usePushContext({
     tools: GlobalTools.use(),
+    messages: GlobalContext.use(),
   })
 
   // XXX: move this to actor state?

catalog/app/components/Assistant/Model/GlobalContext/index.ts

@@ -0,0 +1,49 @@
+import * as React from 'react'
+
+import { useCurrentRoute } from '../navigation'
+
+function useRouteContext() {
+  const { match, loc } = useCurrentRoute()
+
+  const description = React.useMemo(() => {
+    if (!match) return ''
+    const params = match.decoded?.params
+      ? `
+<parameters>
+  ${JSON.stringify(match.decoded.params, null, 2)}
+</parameters>
+`
+      : ''
+    return `
+<route-info>
+  Name: "${match.descriptor.name}"
+  <description>
+    ${match.descriptor.description}
+  </description>
+  ${params}
+</route-info>
+`
+  }, [match])
+
+  const msg = React.useMemo(
+    () =>
+      `
+<viewport>
+  <current-location>
+    ${JSON.stringify(loc, null, 2)}
+  </current-location>
+  ${description}
+  Refer to "navigate" tool schema for navigable routes and their parameters.
+</viewport>
+`,
+    [description, loc],
+  )
+
+  return msg
+}
+
+export function useGlobalContext() {
+  return [useRouteContext()]
+}
+
+export { useGlobalContext as use }

catalog/app/components/Assistant/Model/GlobalTools/__snapshots__/navigate.spec.ts.snap

@@ -213,6 +213,31 @@ exports[`components/Assistant/Model/GlobalTools/navigate NavigateSchema produced
           ],
           "type": "object",
         },
+        {
+          "additionalProperties": false,
+          "description": "Installation page",
+          "properties": {
+            "name": {
+              "const": "install",
+            },
+            "params": {
+              "$id": "/schemas/{}",
+              "oneOf": [
+                {
+                  "type": "object",
+                },
+                {
+                  "type": "array",
+                },
+              ],
+            },
+          },
+          "required": [
+            "name",
+            "params",
+          ],
+          "type": "object",
+        },
         {
           "additionalProperties": false,
           "description": "Search page",
@@ -578,6 +603,56 @@ exports[`components/Assistant/Model/GlobalTools/navigate NavigateSchema produced
           ],
           "type": "object",
         },
+        {
+          "additionalProperties": false,
+          "description": "TBD",
+          "properties": {
+            "name": {
+              "const": "activate",
+            },
+            "params": {
+              "$id": "/schemas/{}",
+              "oneOf": [
+                {
+                  "type": "object",
+                },
+                {
+                  "type": "array",
+                },
+              ],
+            },
+          },
+          "required": [
+            "name",
+            "params",
+          ],
+          "type": "object",
+        },
+        {
+          "additionalProperties": false,
+          "description": "Bucket root page",
+          "properties": {
+            "name": {
+              "const": "bucket",
+            },
+            "params": {
+              "$id": "/schemas/{}",
+              "oneOf": [
+                {
+                  "type": "object",
+                },
+                {
+                  "type": "array",
+                },
+              ],
+            },
+          },
+          "required": [
+            "name",
+            "params",
+          ],
+          "type": "object",
+        },
       ],
     },
   },

catalog/app/components/Assistant/Model/navigation.ts

@@ -1,4 +1,5 @@
 import * as Eff from 'effect'
+import * as React from 'react'
 import * as RR from 'react-router-dom'
 import { Schema as S } from '@effect/schema'
 
@@ -9,21 +10,90 @@ import * as Nav from 'utils/Navigation'
 
 const MODULE = 'Assistant/Model/navigation'
 
-const home = Nav.makeRoute({
-  name: 'home',
-  path: ROUTES.home.path,
-  description: 'Home page',
-  // searchParams: S.Struct({
-  //   // XXX: passing this param doesn't actually work bc of how it's implemented in
-  //   //      website/pages/Landing/Buckets/Buckets.js
-  //   q: SearchParamLastOpt.annotations({
-  //     title: 'bucket filter query',
-  //     description: 'filter buckets in the bucket grid',
-  //   }),
-  // }),
-})
-
-const routeList = [home, search] as const
+// the routes are in the order of matching
+const routeList = [
+  Nav.makeRoute({
+    name: 'home',
+    path: ROUTES.home.path,
+    description: 'Home page',
+    // searchParams: S.Struct({
+    //   // XXX: passing this param doesn't actually work bc of how it's implemented in
+    //   //      website/pages/Landing/Buckets/Buckets.js
+    //   q: SearchParamLastOpt.annotations({
+    //     title: 'bucket filter query',
+    //     description: 'filter buckets in the bucket grid',
+    //   }),
+    // }),
+  }),
+  Nav.makeRoute({
+    name: 'install',
+    path: ROUTES.install.path,
+    description: 'Installation page',
+  }),
+  search,
+  Nav.makeRoute({
+    name: 'activate',
+    path: ROUTES.activate.path,
+    description: 'TBD',
+  }),
+  //         <Route path={paths.signIn} exact>
+  //           <AuthSignIn />
+  //         </Route>
+  //         <Route path="/login" exact>
+  //           <RedirectTo path={urls.signIn()} />
+  //         </Route>
+  //
+  //         <Route path={paths.signOut} exact>
+  //           <AuthSignOut />
+  //         </Route>
+  //
+  //         {(cfg.passwordAuth === true || cfg.ssoAuth === true) && (
+  //           <Route path={paths.signUp} exact>
+  //             <AuthSignUp />
+  //           </Route>
+  //         )}
+  //         {!!cfg.passwordAuth && (
+  //           <Route path={paths.passReset} exact>
+  //             <AuthPassReset />
+  //           </Route>
+  //         )}
+  //         {!!cfg.passwordAuth && (
+  //           <Route path={paths.passChange} exact>
+  //             <AuthPassChange />
+  //           </Route>
+  //         )}
+  //
+  //         <Route path={paths.code} exact>
+  //           <AuthCode />
+  //         </Route>
+  //
+  //         <Route path={paths.activationError} exact>
+  //           <AuthActivationError />
+  //         </Route>
+  //
+  //         {cfg.mode === 'OPEN' && (
+  //           // XXX: show profile in all modes?
+  //           <Route path={paths.profile} exact>
+  //             <OpenProfile />
+  //           </Route>
+  //         )}
+  //
+  //         <Route path={paths.admin}>
+  //           <Admin />
+  //         </Route>
+  //
+  //         <Route path={paths.uriResolver}>
+  //           <UriResolver />
+  //         </Route>
+  //
+  Nav.makeRoute({
+    name: 'bucket',
+    path: ROUTES.bucketRoot.path,
+    description: 'Bucket root page',
+    // XXX: this should hold the bucket name and subroute info (e.g. package vs file view)
+  }),
+] as const
+
 type KnownRoute = (typeof routeList)[number]
 type KnownRouteMap = {
   [K in KnownRoute['name']]: Extract<KnownRoute, { name: K }>
@@ -51,3 +121,42 @@ export const navigate = (route: NavigableRoute, history: History) =>
       Eff.Effect.andThen((loc) => Eff.Effect.sync(() => history.push(loc))),
     ),
   )
+
+interface Match {
+  descriptor: KnownRoute
+  decoded: NavigableRoute | null
+}
+
+const matchLocation = (loc: typeof Nav.Location.Type): Match | null =>
+  Eff.pipe(
+    Eff.Array.findFirst(routeList, (route) =>
+      RR.matchPath(loc.pathname, { path: route.path, exact: true })
+        ? Eff.Option.some(route)
+        : Eff.Option.none(),
+    ),
+    Eff.Option.map((descriptor) => ({
+      descriptor,
+      decoded: Eff.pipe(
+        loc,
+        // @ts-expect-error
+        S.decodeOption(descriptor.paramsSchema),
+        Eff.Option.map((params) => ({ name: descriptor.name, params }) as NavigableRoute),
+        Eff.Option.getOrNull,
+      ),
+    })),
+    Eff.Option.getOrNull,
+  )
+
+interface LocationInfo {
+  loc: typeof Nav.Location.Type
+  match: Match | null
+}
+
+export function useCurrentRoute(): LocationInfo {
+  const loc = RR.useLocation()
+  const match = React.useMemo(
+    () => matchLocation({ pathname: loc.pathname, search: loc.search, hash: '' }),
+    [loc.pathname, loc.search],
+  )
+  return { match, loc }
+}