polen 0.11.0-next.10 → 0.11.0-next.11

package/src/template/components/sidebar/Sidebar.tsx

@@ -1,28 +1,32 @@
 import type { Content } from '#api/content/$'
 import { Box } from '@radix-ui/themes'
 import type { BoxOwnProps, LayoutProps, MarginProps } from '@radix-ui/themes/props'
+import { SidebarContext } from './SidebarContext.js'
 import { Items } from './SidebarItem.js'
 
-interface SidebarProps extends LayoutProps, MarginProps, BoxOwnProps {
+interface Props extends LayoutProps, MarginProps, BoxOwnProps {
   data: Content.Item[]
+  basePath?: string
   style?: React.CSSProperties
 }
 
-export const Sidebar = ({ data, ...props }: SidebarProps) => {
+export const Sidebar = ({ data, basePath, ...props }: Props) => {
   return (
-    <Box
-      data-testid='sidebar'
-      role='Sidebar'
-      {...props}
-    >
-      <style>
-        {`
-          div[role="Sidebar"] a:not([data-active]):hover {
-            background-color: var(--iris-2) !important;
-          }
-        `}
-      </style>
-      <Items items={data} />
-    </Box>
+    <SidebarContext.Provider value={{ basePath }}>
+      <Box
+        data-testid='sidebar'
+        role='Sidebar'
+        {...props}
+      >
+        <style>
+          {`
+            div[role="Sidebar"] a:not([data-active]):hover {
+              background-color: var(--iris-2) !important;
+            }
+          `}
+        </style>
+        <Items items={data} />
+      </Box>
+    </SidebarContext.Provider>
   )
 }

package/src/template/components/sidebar/SidebarContext.tsx

@@ -0,0 +1,7 @@
+import { createContext } from 'react'
+
+interface SidebarContextValue {
+  basePath?: string
+}
+
+export const SidebarContext = createContext<SidebarContextValue>({})

package/src/template/components/sidebar/SidebarItem.tsx

@@ -1,9 +1,12 @@
 import type { Content } from '#api/content/$'
+import { Api } from '#api/iso'
 import type { React } from '#dep/react/index'
 import { Texts } from '#template/components/Texts/index'
 import { Box, Flex } from '@radix-ui/themes'
+import { useContext } from 'react'
 import { useLocation } from 'react-router'
 import { getPathActiveReport, Link } from '../Link.js'
+import { SidebarContext } from './SidebarContext.js'
 
 export const Items: React.FC<{ items: Content.Item[] }> = ({ items }) => {
   return (
@@ -50,15 +53,17 @@ const SBLink: React.FC<{
   link: Content.ItemLink | Content.ItemSection
 }> = ({ link }) => {
   const location = useLocation()
+  const { basePath } = useContext(SidebarContext)
   const currentPathExp = location.pathname
-  const active = getPathActiveReport(link.pathExp, currentPathExp)
+  const href = Api.Schema.Routing.joinSegmentsAndPaths(basePath, link.pathExp)
+  const active = getPathActiveReport(href, currentPathExp)
 
   return (
     <Link
       role='Sidebar Link'
       color={active.is ? `iris` : `gray`}
       data-testid={`sidebar-link-${link.pathExp}`}
-      to={`/${link.pathExp}`}
+      to={href}
       style={{
         display: `block`,
         textDecoration: `none`,
@@ -135,12 +140,14 @@ const LinkedSection: React.FC<{
 
 const SectionLink: React.FC<{ link: Content.ItemLink }> = ({ link }) => {
   const location = useLocation()
-  const active = getPathActiveReport(link.pathExp, location.pathname)
+  const { basePath } = useContext(SidebarContext)
+  const href = Api.Schema.Routing.joinSegmentsAndPaths(basePath, link.pathExp)
+  const active = getPathActiveReport(href, location.pathname)
 
   return (
     <Link
       role='Sidebar Link'
-      to={`/` + link.pathExp}
+      to={href}
       color={active.is ? `iris` : `gray`}
       style={{
         textDecoration: `none`,

package/src/template/hooks/useVersionPath.ts

@@ -1,3 +1,4 @@
+import { Api } from '#api/iso'
 import { useParams } from 'react-router'
 
 /**
@@ -6,5 +7,6 @@ import { useParams } from 'react-router'
  */
 export const useVersionPath = (): string => {
   const params = useParams()
-  return params[`version`] ? `version/${params[`version`]}/` : ``
+  const version = params[`version`] || Api.Schema.VERSION_LATEST
+  return Api.Schema.Routing.createReferenceVersionPath(version)
 }

package/src/template/layouts/SidebarLayout.tsx

@@ -6,12 +6,13 @@ import { useLocation } from 'react-router'
 import { HamburgerMenu } from '../components/HamburgerMenu.js'
 import { Sidebar } from '../components/sidebar/Sidebar.js'
 
-interface SidebarLayoutProps {
+interface Props {
   children: React.ReactNode
   sidebar: Content.Item[]
+  basePath?: string
 }
 
-export const SidebarLayout: React.FC<SidebarLayoutProps> = ({ children, sidebar }) => {
+export const SidebarLayout: React.FC<Props> = ({ children, sidebar, basePath }) => {
   const location = useLocation()
   const [mobileMenuOpen, setMobileMenuOpen] = useState(false)
 
@@ -45,6 +46,7 @@ export const SidebarLayout: React.FC<SidebarLayoutProps> = ({ children, sidebar
               setMobileMenuOpen(false)
             }}
             sidebarData={sidebar}
+            basePath={basePath}
           />
         </Box>
       )}
@@ -56,7 +58,7 @@ export const SidebarLayout: React.FC<SidebarLayoutProps> = ({ children, sidebar
           gridColumn='1 / 3'
           gridRow='1 / auto'
         >
-          <Sidebar data={sidebar} />
+          <Sidebar data={sidebar} basePath={basePath} />
         </Box>
       )}
 

package/src/template/routes/reference.tsx

@@ -1,4 +1,5 @@
 import type { Content } from '#api/content/$'
+import { Api } from '#api/iso'
 import { GrafaidOld } from '#lib/grafaid-old/index'
 import { Grafaid } from '#lib/grafaid/index'
 import { route, routeIndex } from '#lib/react-router-aid/react-router-aid'
@@ -10,14 +11,13 @@ import { MissingSchema } from '../components/MissingSchema.js'
 import { NamedType } from '../components/NamedType.js'
 import { VersionSelector } from '../components/VersionSelector.js'
 import { SidebarLayout } from '../layouts/index.js'
-import { VERSION_LATEST } from '../lib/schema-utils/constants.js'
 import { schemaSource } from '../sources/schema-source.js'
 
 export const loader = createLoader(async ({ params }) => {
   // Handle both versioned and unversioned routes:
   // - Versioned: /reference/version/:version/:type → params.version exists
   // - Unversioned: /reference/:type → params.version is undefined, defaults to latest
-  const currentVersion = params.version ?? VERSION_LATEST
+  const currentVersion = params.version ?? Api.Schema.VERSION_LATEST
 
   const schema = await schemaSource.get(currentVersion)
   const availableVersions = schemaSource.versions
@@ -42,12 +42,6 @@ const RouteReferenceComponent = () => {
   const sidebarItems: Content.Item[] = []
   const kindEntries = Object.entries(kindMap.list).filter(([_, types]) => types.length > 0)
 
-  // Build path prefix based on current version from loader data
-  // This ensures sidebar links always match the current version being viewed
-  const versionPath = data.currentVersion === VERSION_LATEST
-    ? ``
-    : `version/${data.currentVersion}/`
-
   for (const [title, types] of kindEntries) {
     sidebarItems.push({
       type: `ItemSection` as const,
@@ -57,13 +51,16 @@ const RouteReferenceComponent = () => {
       links: types.map(type => ({
         type: `ItemLink` as const,
         title: type.name,
-        pathExp: `reference/${versionPath}${type.name}`,
+        pathExp: type.name, // Just the type name, basePath will be prepended
       })),
     })
   }
 
+  // Calculate basePath based on current version
+  const basePath = Api.Schema.Routing.createReferenceBasePath(data.currentVersion)
+
   return (
-    <SidebarLayout sidebar={sidebarItems}>
+    <SidebarLayout sidebar={sidebarItems} basePath={basePath}>
       <Box mb={`4`}>
         <VersionSelector
           availableVersions={data.availableVersions}

package/src/template/server/ssg/get-route-paths.test.ts

@@ -50,6 +50,19 @@ vi.mock('#api/index', () => ({
     Schema: {
       getMetadata: vi.fn(),
       VERSION_LATEST: 'latest',
+      Routing: {
+        createReferencePath: vi.fn((parts) => {
+          const version = parts.version || 'latest'
+          const basePath = version === 'latest' ? '/reference' : `/reference/version/${version}`
+          if (parts.type) {
+            return parts.field ? `${basePath}/${parts.type}/${parts.field}` : `${basePath}/${parts.type}`
+          }
+          return basePath
+        }),
+        createReferenceBasePath: vi.fn((version) => {
+          return version === 'latest' ? '/reference' : `/reference/version/${version}`
+        }),
+      },
     },
   },
 }))

package/src/template/server/ssg/get-route-paths.ts

@@ -22,7 +22,7 @@ export const getRoutesPaths = async (): Promise<string[]> => {
   const routeExpressions = ReactRouterAid.getRouteExpressions(routes)
 
   // Helper function to load schema from filesystem and add type paths
-  const addTypePathsForVersion = async (version: string, pathPrefix: string, includeFields = false) => {
+  const addTypePathsForVersion = async (version: string, includeFields = false) => {
     try {
       const schemaFilePath = NodePath.join(PROJECT_DATA.paths.project.absolute.build.assets.schemas, `${version}.json`)
       const schemaContent = await NodeFs.readFile(schemaFilePath, 'utf-8')
@@ -30,38 +30,70 @@ export const getRoutesPaths = async (): Promise<string[]> => {
 
       visit(schemaAst, {
         ObjectTypeDefinition(node) {
-          const typePath = `${pathPrefix}/${node.name.value}`
+          const typePath = Api.Schema.Routing.createReferencePath({
+            version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+            type: node.name.value,
+          })
           paths.add(typePath)
 
           // Add field paths if requested
           if (includeFields && node.fields) {
             for (const field of node.fields) {
-              paths.add(`${typePath}/${field.name.value}`)
+              const fieldPath = Api.Schema.Routing.createReferencePath({
+                version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+                type: node.name.value,
+                field: field.name.value,
+              })
+              paths.add(fieldPath)
             }
           }
         },
         InterfaceTypeDefinition(node) {
-          const typePath = `${pathPrefix}/${node.name.value}`
+          const typePath = Api.Schema.Routing.createReferencePath({
+            version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+            type: node.name.value,
+          })
           paths.add(typePath)
 
           // Add field paths if requested
           if (includeFields && node.fields) {
             for (const field of node.fields) {
-              paths.add(`${typePath}/${field.name.value}`)
+              const fieldPath = Api.Schema.Routing.createReferencePath({
+                version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+                type: node.name.value,
+                field: field.name.value,
+              })
+              paths.add(fieldPath)
             }
           }
         },
         EnumTypeDefinition(node) {
-          paths.add(`${pathPrefix}/${node.name.value}`)
+          const typePath = Api.Schema.Routing.createReferencePath({
+            version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+            type: node.name.value,
+          })
+          paths.add(typePath)
         },
         InputObjectTypeDefinition(node) {
-          paths.add(`${pathPrefix}/${node.name.value}`)
+          const typePath = Api.Schema.Routing.createReferencePath({
+            version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+            type: node.name.value,
+          })
+          paths.add(typePath)
         },
         UnionTypeDefinition(node) {
-          paths.add(`${pathPrefix}/${node.name.value}`)
+          const typePath = Api.Schema.Routing.createReferencePath({
+            version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+            type: node.name.value,
+          })
+          paths.add(typePath)
         },
         ScalarTypeDefinition(node) {
-          paths.add(`${pathPrefix}/${node.name.value}`)
+          const typePath = Api.Schema.Routing.createReferencePath({
+            version: version === Api.Schema.VERSION_LATEST ? undefined : version,
+            type: node.name.value,
+          })
+          paths.add(typePath)
         },
       })
     } catch (error) {
@@ -78,32 +110,33 @@ export const getRoutesPaths = async (): Promise<string[]> => {
     if (exp === knownParameterizedRouteExpressions.reference_type) {
       if (hasSchema) {
         // Add paths for latest version (no version in URL)
-        await addTypePathsForVersion(Api.Schema.VERSION_LATEST, `/reference`)
+        await addTypePathsForVersion(Api.Schema.VERSION_LATEST)
       }
     } else if (exp === knownParameterizedRouteExpressions.reference_version) {
       if (hasSchema) {
         // Add paths for version pages themselves (without type)
         for (const version of availableVersions) {
-          paths.add(`/reference/version/${version}`)
+          const versionPath = Api.Schema.Routing.createReferenceBasePath(version)
+          paths.add(versionPath)
         }
       }
     } else if (exp === knownParameterizedRouteExpressions.reference_type_field) {
       if (hasSchema) {
         // Add paths for latest version fields
-        await addTypePathsForVersion(Api.Schema.VERSION_LATEST, `/reference`, true)
+        await addTypePathsForVersion(Api.Schema.VERSION_LATEST, true)
       }
     } else if (exp === knownParameterizedRouteExpressions.reference_versioned_type) {
       if (hasSchema) {
         // Add paths for all versions using new route structure
         for (const version of availableVersions) {
-          await addTypePathsForVersion(version, `/reference/version/${version}`)
+          await addTypePathsForVersion(version)
         }
       }
     } else if (exp === knownParameterizedRouteExpressions.reference_versioned_type_field) {
       if (hasSchema) {
         // Add paths for all versions with fields
         for (const version of availableVersions) {
-          await addTypePathsForVersion(version, `/reference/version/${version}`, true)
+          await addTypePathsForVersion(version, true)
         }
       }
     } else if (ReactRouterAid.isParameterizedPath(exp)) {

package/build/template/lib/schema-utils/constants.d.ts

@@ -1,5 +0,0 @@
-/**
- * Re-exports of schema constants for template usage
- */
-export { dateToVersionString, VERSION_LATEST } from '#api/schema/schema';
-//# sourceMappingURL=constants.d.ts.map

package/build/template/lib/schema-utils/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/template/lib/schema-utils/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA"}

package/build/template/lib/schema-utils/constants.js

@@ -1,5 +0,0 @@
-/**
- * Re-exports of schema constants for template usage
- */
-export { dateToVersionString, VERSION_LATEST } from '#api/schema/schema';
-//# sourceMappingURL=constants.js.map

package/build/template/lib/schema-utils/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/template/lib/schema-utils/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA"}

package/src/template/lib/schema-utils/constants.ts

@@ -1,4 +0,0 @@
-/**
- * Re-exports of schema constants for template usage
- */
-export { dateToVersionString, VERSION_LATEST } from '#api/schema/schema'