mirror of
https://github.com/supabase/supabase.git
synced 2026-09-09 19:42:46 +08:00
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Docs update. * https://docs-git-docs-wire-server-v1-reference-supabase.vercel.app/docs/reference/server/introduction * <img width="417" height="628" alt="Screenshot 2026-07-06 at 6 13 33 PM" src="https://github.com/user-attachments/assets/9fc27b04-038b-4434-8855-94051f898b5d" /> ## What is the current behavior? `@supabase/server` has no reference documentation page in the Supabase docs. The library publishes a TypeDoc spec to GitHub Pages but the docs pipeline was not wired up to consume it. ## What is the new behavior? - Adds `spec/reference/server/v1/` with a `config.json` (category order: Middleware, Primitives, Adapters, Errors, Types) and `partials/` for the introduction and installing pages. - Adds a `download.server.v1` Makefile target that fetches `https://supabase.github.io/server/spec.json` into `spec/reference/server/v1/server.json`, and wires it into the top-level `download` target so it runs with the rest. - Registers `server-v1` in `SUPPORTS_NEW_REFERENCE_PROCESS` so the build pipeline picks up the new spec directory and generates `content/reference/server/v1/` at build time. - Seeds the generated `docs/ref/server/` partials (introduction and installing) that the reference router serves. ## Additional context The TypeDoc spec is produced by `@supabase/server`'s `docs.yml` workflow on every push to `main`, so `make download.server.v1` will always pull the latest published API surface. The companion PR in the server repo ([supabase/server#95](https://github.com/supabase/server/pull/95)) adds the `@category` tags that the pipeline requires for symbols to appear in navigation. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a new **Server SDK** item under **Reference**, linking to `/reference/server` and marked with a **New** badge. * Published **Server Reference v1** documentation for `@supabase/server`, including **Introduction** and **Installing** pages. * **Chores / Improvements** * Enhanced the reference documentation generation to include Server v1 content. * Improved reference detail handling (including clearer TypeDoc output such as **Deprecated** notes). <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
196 lines
7.8 KiB
TypeScript
196 lines
7.8 KiB
TypeScript
'use client'
|
|
|
|
import Link from 'next/link'
|
|
import { usePathname } from 'next/navigation'
|
|
import React, { FC, Fragment, useEffect, useState } from 'react'
|
|
import {
|
|
Badge,
|
|
cn,
|
|
MenubarSeparator,
|
|
NavigationMenu,
|
|
NavigationMenuContent,
|
|
NavigationMenuItem,
|
|
NavigationMenuLink,
|
|
NavigationMenuList,
|
|
NavigationMenuTrigger,
|
|
navigationMenuTriggerStyle,
|
|
} from 'ui'
|
|
|
|
import MenuIconPicker from './MenuIconPicker'
|
|
import { GLOBAL_MENU_ITEMS } from './NavigationMenu.constants'
|
|
|
|
/**
|
|
* Get TopNav active label based on current pathname
|
|
*/
|
|
export const useActiveMenuLabel = (menu: typeof GLOBAL_MENU_ITEMS) => {
|
|
const pathname = usePathname()
|
|
const [activeLabel, setActiveLabel] = useState('')
|
|
|
|
useEffect(() => {
|
|
// check if homepage
|
|
if (pathname === '/') {
|
|
return setActiveLabel('Home')
|
|
}
|
|
|
|
for (let index = 0; index < menu.length; index++) {
|
|
const section = menu[index]
|
|
if (section[0].enabled === false) continue
|
|
|
|
// check if first level menu items match beginning of url
|
|
if (section[0].href?.startsWith(pathname)) {
|
|
return setActiveLabel(section[0].label)
|
|
}
|
|
// check if second level menu items match beginning of url
|
|
if (section[0].menuItems) {
|
|
section[0].menuItems.map((menuItemGroup) =>
|
|
menuItemGroup
|
|
.filter((menuItem) => menuItem.enabled !== false)
|
|
.map(
|
|
(menuItem) => menuItem.href?.startsWith(pathname) && setActiveLabel(section[0].label)
|
|
)
|
|
)
|
|
}
|
|
}
|
|
}, [pathname, menu])
|
|
|
|
return activeLabel
|
|
}
|
|
|
|
const GlobalNavigationMenu: FC = () => {
|
|
const activeLabel = useActiveMenuLabel(GLOBAL_MENU_ITEMS)
|
|
const triggerClassName =
|
|
'h-(--header-height) p-2 bg-transparent border-0 border-b-2 border-transparent font-normal rounded-none text-foreground-light hover:bg-transparent hover:text-foreground data-open:bg-transparent! data-open:text-foreground! data-radix-collection-item:focus-visible:ring-2 data-radix-collection-item:focus-visible:ring-foreground-lighter data-radix-collection-item:focus-visible:text-foreground h-full focus-visible:rounded-sm shadow-none! outline-hidden transition-all outline-0 focus-visible:outline-4 focus-visible:outline-offset-1 focus-visible:outline-brand-600'
|
|
|
|
return (
|
|
<div className="flex relative gap-2 justify-start items-end w-full h-full">
|
|
<NavigationMenu
|
|
delayDuration={0}
|
|
skipDelayDuration={0}
|
|
className="w-full flex justify-start h-full"
|
|
renderViewport={false}
|
|
viewportClassName="mt-0 max-w-screen overflow-hidden border-0 rounded-none mt-1.5 rounded-md border-x!"
|
|
>
|
|
<NavigationMenuList className="px-6 space-x-2 h-(--header-height)">
|
|
{GLOBAL_MENU_ITEMS.filter((section) => section[0].enabled !== false).map(
|
|
(section, sectionIdx) =>
|
|
section[0].menuItems ? (
|
|
<NavigationMenuItem
|
|
key={`desktop-docs-menu-section-${section[0].label}-${sectionIdx}`}
|
|
className="text-sm relative h-full"
|
|
>
|
|
<NavigationMenuTrigger
|
|
className={cn(
|
|
navigationMenuTriggerStyle(),
|
|
triggerClassName,
|
|
activeLabel === section[0].label && 'text-foreground border-foreground'
|
|
)}
|
|
>
|
|
{section[0].label === 'Home' ? (
|
|
<MenuIconPicker icon={section[0].icon || ''} />
|
|
) : (
|
|
section[0].label
|
|
)}
|
|
</NavigationMenuTrigger>
|
|
<NavigationMenuContent className="top-[calc(100%+4px)]! min-w-56 max-h-[calc(100vh-4rem)] border-y w-screen md:w-64 overflow-hidden overflow-y-auto rounded-none md:rounded-md md:border border-overlay bg-overlay text-foreground-light shadow-md duration-0!">
|
|
<div className="p-3 md:p-1">
|
|
{section[0].menuItems?.map((menuItem, menuItemIndex) => (
|
|
<Fragment
|
|
key={`desktop-docs-menu-section-${menuItemIndex}-${menuItemIndex}`}
|
|
>
|
|
{menuItemIndex !== 0 && <MenubarSeparator className="bg-border-muted" />}
|
|
{menuItem
|
|
.filter((item) => item.enabled !== false)
|
|
.map((item, itemIdx) =>
|
|
!item.href ? (
|
|
<div
|
|
key={`desktop-docs-menu-section-label-${item.label}-${itemIdx}`}
|
|
className="font-mono tracking-wider flex items-center text-foreground-muted text-xs uppercase rounded-md p-2 leading-none"
|
|
>
|
|
{item.label}
|
|
</div>
|
|
) : (
|
|
<NavigationMenuLink
|
|
key={`desktop-docs-menu-section-label-${item.label}-${itemIdx}`}
|
|
asChild
|
|
>
|
|
<MenuItem
|
|
href={item.href}
|
|
title={item.label}
|
|
community={item.community}
|
|
new={item.new}
|
|
icon={item.icon}
|
|
/>
|
|
</NavigationMenuLink>
|
|
)
|
|
)}
|
|
</Fragment>
|
|
))}
|
|
</div>
|
|
</NavigationMenuContent>
|
|
</NavigationMenuItem>
|
|
) : (
|
|
<NavigationMenuItem
|
|
key={`desktop-docs-menu-section-${section[0].label}-${sectionIdx}`}
|
|
className="text-sm relative h-full"
|
|
>
|
|
<NavigationMenuLink asChild>
|
|
<Link
|
|
href={section[0].href || '#'}
|
|
className={cn(
|
|
navigationMenuTriggerStyle(),
|
|
triggerClassName,
|
|
activeLabel === section[0].label && 'text-foreground border-foreground'
|
|
)}
|
|
>
|
|
{section[0].label === 'Home' ? (
|
|
<MenuIconPicker icon={section[0].icon || ''} />
|
|
) : (
|
|
section[0].label
|
|
)}
|
|
</Link>
|
|
</NavigationMenuLink>
|
|
</NavigationMenuItem>
|
|
)
|
|
)}
|
|
</NavigationMenuList>
|
|
</NavigationMenu>
|
|
</div>
|
|
)
|
|
}
|
|
|
|
export const MenuItem = React.forwardRef<
|
|
React.ElementRef<'a'>,
|
|
React.ComponentPropsWithoutRef<'a'> & {
|
|
icon?: string
|
|
community?: boolean
|
|
new?: boolean
|
|
}
|
|
>(({ className, title, href = '', icon, community, new: isNew, children, ...props }, ref) => {
|
|
return (
|
|
<Link
|
|
href={href}
|
|
ref={ref}
|
|
className={cn(
|
|
'group/menu-item flex items-center gap-2',
|
|
'w-full flex h-8 items-center text-foreground-light text-sm hover:text-foreground select-none rounded-md p-2 leading-none no-underline outline-hidden! focus-visible:ring-2 focus-visible:ring-foreground-lighter focus-visible:text-foreground',
|
|
className
|
|
)}
|
|
{...props}
|
|
>
|
|
{children ?? (
|
|
<>
|
|
{icon && <MenuIconPicker icon={icon} className="text-foreground-lighter" />}
|
|
<span className="flex-1">{title}</span>
|
|
{community && <Badge>Community</Badge>}
|
|
{isNew && <Badge variant="success">New</Badge>}
|
|
</>
|
|
)}
|
|
</Link>
|
|
)
|
|
})
|
|
|
|
GlobalNavigationMenu.displayName = 'GlobalNavigationMenu'
|
|
MenuItem.displayName = 'MenuItem'
|
|
|
|
export default GlobalNavigationMenu
|