Files
supabase/apps/studio/state/sidebar-manager-state.tsx
Gildas Garcia c6fc456910 chore: cleanup duplicate exports studio (#47387)
## Problem

Knip reports many duplicate exports (both named and default). Besides,
we're moving away from default exports and even have an eslint rule to
enforce it on new code.

## Solution

- Cleanup those exports
- Update imports when necessary

No functional changes. If it builds, it's fine
2026-06-29 15:46:16 +02:00

183 lines
4.4 KiB
TypeScript

import { ReactNode, useEffect } from 'react'
import { proxy, snapshot, useSnapshot } from 'valtio'
import { useLatest } from '@/hooks/misc/useLatest'
type SidebarHandlers = {
onOpen?: () => void
onClose?: () => void
}
type ManagedSidebar = SidebarHandlers & {
id: string
component: () => ReactNode | undefined
}
type SidebarManagerData = {
sidebars: Partial<Record<string, ManagedSidebar>>
activeSidebar: ManagedSidebar | undefined
pendingSidebarOpen: string | undefined
}
type SidebarManagerState = SidebarManagerData & {
registerSidebar: (
id: string,
component: () => ReactNode | undefined,
handlers?: SidebarHandlers
) => void
unregisterSidebar: (id: string) => void
openSidebar: (id: string) => void
toggleSidebar: (id: string) => void
closeSidebar: (id: string) => void
isSidebarOpen: (id: string) => boolean
closeActive: () => void
clearActiveSidebar: () => void
}
const INITIAL_SIDEBAR_MANAGER_DATA: SidebarManagerData = {
sidebars: {},
activeSidebar: undefined,
pendingSidebarOpen: undefined,
}
const createSidebarManagerState = () => {
const state: SidebarManagerState = proxy({
...INITIAL_SIDEBAR_MANAGER_DATA,
registerSidebar(
id: string,
component: () => ReactNode | undefined,
handlers: SidebarHandlers = {}
) {
state.sidebars[id] = {
id,
component,
...handlers,
}
// If this sidebar was pending to be opened, open it now
if (state.pendingSidebarOpen === id) {
state.pendingSidebarOpen = undefined
state.openSidebar(id)
}
},
unregisterSidebar(id: string) {
const panel = state.sidebars[id]
if (!panel) return
delete state.sidebars[id]
// Clear pending open if this sidebar was pending
if (state.pendingSidebarOpen === id) {
state.pendingSidebarOpen = undefined
}
if (state.activeSidebar?.id === id) {
state.activeSidebar = undefined
panel.onClose?.()
}
},
openSidebar(id: string) {
const panel = state.sidebars[id]
if (!panel) {
// Queue the request - sidebar will be opened when it gets registered
state.pendingSidebarOpen = id
return
}
// Clear any pending request since we're opening a sidebar now
state.pendingSidebarOpen = undefined
if (state.activeSidebar?.id === id) {
return
}
if (state.activeSidebar && state.activeSidebar.id !== id) {
const previousPanel = state.activeSidebar
previousPanel?.onClose?.()
}
state.activeSidebar = panel
panel.onOpen?.()
},
toggleSidebar(id: string) {
const panel = state.sidebars[id]
if (!panel) {
console.warn(`Sidebar "${id}" is not registered. Register it before toggling.`)
return
}
if (state.activeSidebar?.id === id) {
panel.onClose?.()
state.activeSidebar = undefined
return
}
if (state.activeSidebar && state.activeSidebar.id !== id) {
const previousPanel = state.activeSidebar
previousPanel?.onClose?.()
}
state.activeSidebar = panel
panel.onOpen?.()
},
closeSidebar(id: string) {
if (state.activeSidebar?.id !== id) return
const panel = state.sidebars[id]
if (!panel) return
panel.onClose?.()
state.activeSidebar = undefined
return
},
isSidebarOpen(id: string) {
return state.activeSidebar?.id === id
},
closeActive() {
if (!state.activeSidebar) return
state.activeSidebar?.onClose?.()
state.activeSidebar = undefined
},
clearActiveSidebar() {
state.activeSidebar = undefined
},
})
return state
}
export const sidebarManagerState = createSidebarManagerState()
export const getSidebarManagerSnapshot = () => snapshot(sidebarManagerState)
export const useSidebarManagerSnapshot = (options?: Parameters<typeof useSnapshot>[1]) =>
useSnapshot(sidebarManagerState, options)
export const useRegisterSidebar = (
id: string,
component: () => ReactNode,
handlers: SidebarHandlers = {},
enabled?: boolean
) => {
const componentRef = useLatest(component)
const handlersRef = useLatest(handlers)
useEffect(() => {
if (enabled) {
sidebarManagerState.registerSidebar(id, () => componentRef.current(), handlersRef.current)
}
return () => {
sidebarManagerState.unregisterSidebar(id)
}
}, [id, enabled])
}