| 1 | import { ChevronRightIcon, ExternalLinkIcon, SearchIcon } from "lucide-react"; |
| 2 | import { useCallback, useEffect, useMemo, useState } from "react"; |
| 3 | |
| 4 | import { |
| 5 | decodeThirdPartyLicenseManifest, |
| 6 | filterThirdPartyLicenseEntries, |
| 7 | formatLicenseBundles, |
| 8 | thirdPartyLicenseEntryKey, |
| 9 | type ThirdPartyLicenseEntry, |
| 10 | type ThirdPartyLicenseManifest, |
| 11 | } from "@t3tools/shared/thirdPartyLicenses"; |
| 12 | |
| 13 | import { Button } from "../ui/button"; |
| 14 | import { Collapsible, CollapsiblePanel, CollapsibleTrigger } from "../ui/collapsible"; |
| 15 | import { InputGroup, InputGroupAddon, InputGroupInput } from "../ui/input-group"; |
| 16 | import { Tooltip, TooltipPopup, TooltipTrigger } from "../ui/tooltip"; |
| 17 | import { SettingsPageContainer, SettingsSection } from "./settingsLayout"; |
| 18 | |
| 19 | type LicenseManifestState = |
| 20 | | { readonly status: "loading" } |
| 21 | | { readonly status: "error"; readonly message: string } |
| 22 | | { readonly status: "ready"; readonly manifest: ThirdPartyLicenseManifest }; |
| 23 | |
| 24 | let licenseManifestPromise: Promise<ThirdPartyLicenseManifest> | undefined; |
| 25 | |
| 26 | async function fetchLicenseManifest(): Promise<ThirdPartyLicenseManifest> { |
| 27 | const signal = AbortSignal.timeout(30_000); |
| 28 | try { |
| 29 | const response = await fetch( |
| 30 | `${import.meta.env.BASE_URL.replace(/\/$/, "")}/third-party-licenses.json`, |
| 31 | { signal }, |
| 32 | ); |
| 33 | if (!response.ok) { |
| 34 | throw new Error( |
| 35 | `The license manifest request failed with status ${String(response.status)}.`, |
| 36 | ); |
| 37 | } |
| 38 | return decodeThirdPartyLicenseManifest((await response.json()) as unknown); |
| 39 | } catch (error) { |
| 40 | if (signal.aborted) { |
| 41 | throw new Error("The license manifest took too long to load.", { cause: error }); |
| 42 | } |
| 43 | throw error; |
| 44 | } |
| 45 | } |
| 46 | |
| 47 | function loadLicenseManifest(): Promise<ThirdPartyLicenseManifest> { |
| 48 | licenseManifestPromise ??= fetchLicenseManifest().catch((error: unknown) => { |
| 49 | licenseManifestPromise = undefined; |
| 50 | throw error; |
| 51 | }); |
| 52 | return licenseManifestPromise; |
| 53 | } |
| 54 | |
| 55 | function LicenseNoticeRow({ |
| 56 | entry, |
| 57 | open, |
| 58 | onOpenChange, |
| 59 | }: { |
| 60 | readonly entry: ThirdPartyLicenseEntry; |
| 61 | readonly open: boolean; |
| 62 | readonly onOpenChange: (open: boolean) => void; |
| 63 | }) { |
| 64 | return ( |
| 65 | <Collapsible open={open} onOpenChange={onOpenChange}> |
| 66 | <article> |
| 67 | <div className="flex min-h-10 items-center hover:bg-muted/35 sm:min-h-9"> |
| 68 | <CollapsibleTrigger className="group flex min-h-10 min-w-0 flex-1 items-center gap-2.5 px-3 text-left sm:min-h-9 sm:px-4"> |
| 69 | <ChevronRightIcon |
| 70 | aria-hidden |
| 71 | className="size-3.5 shrink-0 text-muted-foreground transition-transform duration-200 group-data-panel-open:rotate-90" |
| 72 | /> |
| 73 | <span className="flex min-w-0 flex-1 items-baseline gap-2"> |
| 74 | <span className="truncate font-medium text-foreground">{entry.name}</span> |
| 75 | {entry.version ? ( |
| 76 | <code className="shrink-0 text-xs text-muted-foreground">{entry.version}</code> |
| 77 | ) : null} |
| 78 | </span> |
| 79 | <span className="max-w-[42%] shrink-0 truncate text-xs text-muted-foreground"> |
| 80 | {entry.license} · {formatLicenseBundles(entry.bundles)} |
| 81 | </span> |
| 82 | </CollapsibleTrigger> |
| 83 | {entry.sourceUrl ? ( |
| 84 | <Button |
| 85 | aria-label={`View project source for ${entry.name}`} |
| 86 | className="me-3 shrink-0 sm:me-4" |
| 87 | render={<a href={entry.sourceUrl} rel="noreferrer noopener" target="_blank" />} |
| 88 | size="icon-micro" |
| 89 | title="Project source" |
| 90 | variant="ghost-muted" |
| 91 | > |
| 92 | <ExternalLinkIcon aria-hidden className="size-3" /> |
| 93 | </Button> |
| 94 | ) : null} |
| 95 | </div> |
| 96 | <CollapsiblePanel> |
| 97 | {open ? ( |
| 98 | <div className="px-9 pt-1 pb-4 sm:px-10"> |
| 99 | <pre className="max-w-[76ch] whitespace-pre-wrap break-words font-mono text-xs/5 text-foreground/80"> |
| 100 | {entry.noticeText} |
| 101 | </pre> |
| 102 | </div> |
| 103 | ) : null} |
| 104 | </CollapsiblePanel> |
| 105 | </article> |
| 106 | </Collapsible> |
| 107 | ); |
| 108 | } |
| 109 | |
| 110 | function LicenseCount({ |
| 111 | filteredCount, |
| 112 | totalCount, |
| 113 | }: { |
| 114 | filteredCount: number; |
| 115 | totalCount: number; |
| 116 | }) { |
| 117 | return ( |
| 118 | <p className="whitespace-nowrap text-xs font-normal text-muted-foreground tabular-nums"> |
| 119 | {filteredCount === totalCount |
| 120 | ? `${String(totalCount)} notices` |
| 121 | : `${String(filteredCount)} of ${String(totalCount)}`} |
| 122 | </p> |
| 123 | ); |
| 124 | } |
| 125 | |
| 126 | function LicenseHeaderAction({ |
| 127 | query, |
| 128 | onQueryChange, |
| 129 | searchOpen, |
| 130 | onSearchOpenChange, |
| 131 | filteredCount, |
| 132 | totalCount, |
| 133 | }: { |
| 134 | query: string; |
| 135 | onQueryChange: (value: string) => void; |
| 136 | searchOpen: boolean; |
| 137 | onSearchOpenChange: (open: boolean) => void; |
| 138 | filteredCount: number; |
| 139 | totalCount: number; |
| 140 | }) { |
| 141 | if (!searchOpen) { |
| 142 | return ( |
| 143 | <div className="flex items-center gap-1.5"> |
| 144 | <LicenseCount filteredCount={filteredCount} totalCount={totalCount} /> |
| 145 | <Tooltip> |
| 146 | <TooltipTrigger |
| 147 | render={ |
| 148 | <Button |
| 149 | aria-label="Search open-source licenses" |
| 150 | onClick={() => onSearchOpenChange(true)} |
| 151 | size="icon-micro" |
| 152 | type="button" |
| 153 | variant="ghost-muted" |
| 154 | > |
| 155 | <SearchIcon className="size-3" /> |
| 156 | </Button> |
| 157 | } |
| 158 | /> |
| 159 | <TooltipPopup side="top">Search licenses</TooltipPopup> |
| 160 | </Tooltip> |
| 161 | </div> |
| 162 | ); |
| 163 | } |
| 164 | |
| 165 | return ( |
| 166 | <div className="flex items-center gap-2"> |
| 167 | <div className="hidden sm:block"> |
| 168 | <LicenseCount filteredCount={filteredCount} totalCount={totalCount} /> |
| 169 | </div> |
| 170 | <InputGroup className="w-36 sm:w-44"> |
| 171 | <InputGroupAddon> |
| 172 | <SearchIcon aria-hidden className="size-3" /> |
| 173 | </InputGroupAddon> |
| 174 | <InputGroupInput |
| 175 | aria-label="Search open-source licenses" |
| 176 | autoFocus |
| 177 | onBlur={() => { |
| 178 | if (query.length === 0) onSearchOpenChange(false); |
| 179 | }} |
| 180 | onChange={(event) => onQueryChange(event.currentTarget.value)} |
| 181 | onKeyDown={(event) => { |
| 182 | if (event.key !== "Escape") return; |
| 183 | event.preventDefault(); |
| 184 | onQueryChange(""); |
| 185 | onSearchOpenChange(false); |
| 186 | }} |
| 187 | placeholder="Search licenses" |
| 188 | size="sm" |
| 189 | type="search" |
| 190 | value={query} |
| 191 | /> |
| 192 | </InputGroup> |
| 193 | </div> |
| 194 | ); |
| 195 | } |
| 196 | |
| 197 | function LicenseManifestError({ message, onRetry }: { message: string; onRetry: () => void }) { |
| 198 | return ( |
| 199 | <div className="flex flex-col items-start gap-3 px-3 py-5 sm:px-4"> |
| 200 | <div className="flex flex-col gap-1"> |
| 201 | <h3 className="text-sm font-medium text-foreground">Open-source notices are unavailable</h3> |
| 202 | <p className="max-w-[70ch] text-pretty text-xs leading-normal text-muted-foreground/80"> |
| 203 | {message} |
| 204 | </p> |
| 205 | </div> |
| 206 | <Button type="button" size="xs" variant="outline" onClick={onRetry}> |
| 207 | Try again |
| 208 | </Button> |
| 209 | </div> |
| 210 | ); |
| 211 | } |
| 212 | |
| 213 | export function OpenSourceLicensesPanel() { |
| 214 | const [state, setState] = useState<LicenseManifestState>({ status: "loading" }); |
| 215 | const [query, setQuery] = useState(""); |
| 216 | const [searchOpen, setSearchOpen] = useState(false); |
| 217 | const [openEntryKey, setOpenEntryKey] = useState<string | null>(null); |
| 218 | const [requestVersion, setRequestVersion] = useState(0); |
| 219 | |
| 220 | useEffect(() => { |
| 221 | let cancelled = false; |
| 222 | setState({ status: "loading" }); |
| 223 | void loadLicenseManifest().then( |
| 224 | (manifest) => { |
| 225 | if (!cancelled) setState({ status: "ready", manifest }); |
| 226 | }, |
| 227 | (error: unknown) => { |
| 228 | if (cancelled) return; |
| 229 | setState({ |
| 230 | status: "error", |
| 231 | message: error instanceof Error ? error.message : "The license manifest could not load.", |
| 232 | }); |
| 233 | }, |
| 234 | ); |
| 235 | return () => { |
| 236 | cancelled = true; |
| 237 | }; |
| 238 | }, [requestVersion]); |
| 239 | |
| 240 | const entries = state.status === "ready" ? state.manifest.entries : []; |
| 241 | const filteredEntries = useMemo( |
| 242 | () => filterThirdPartyLicenseEntries(entries, query), |
| 243 | [entries, query], |
| 244 | ); |
| 245 | const retry = useCallback(() => setRequestVersion((value) => value + 1), []); |
| 246 | |
| 247 | return ( |
| 248 | <SettingsPageContainer> |
| 249 | <SettingsSection |
| 250 | title="Third-party notices" |
| 251 | headerAction={ |
| 252 | state.status === "ready" ? ( |
| 253 | <LicenseHeaderAction |
| 254 | query={query} |
| 255 | onQueryChange={setQuery} |
| 256 | searchOpen={searchOpen} |
| 257 | onSearchOpenChange={setSearchOpen} |
| 258 | filteredCount={filteredEntries.length} |
| 259 | totalCount={entries.length} |
| 260 | /> |
| 261 | ) : null |
| 262 | } |
| 263 | > |
| 264 | {state.status === "ready" ? ( |
| 265 | <div className="text-base sm:text-sm"> |
| 266 | {filteredEntries.length > 0 ? ( |
| 267 | filteredEntries.map((entry) => { |
| 268 | const entryKey = thirdPartyLicenseEntryKey(entry); |
| 269 | return ( |
| 270 | <LicenseNoticeRow |
| 271 | key={entryKey} |
| 272 | entry={entry} |
| 273 | open={openEntryKey === entryKey} |
| 274 | onOpenChange={(open) => setOpenEntryKey(open ? entryKey : null)} |
| 275 | /> |
| 276 | ); |
| 277 | }) |
| 278 | ) : ( |
| 279 | <p className="px-3 py-8 text-center text-sm/6 text-muted-foreground sm:px-4"> |
| 280 | No licenses match that search. |
| 281 | </p> |
| 282 | )} |
| 283 | </div> |
| 284 | ) : state.status === "error" ? ( |
| 285 | <LicenseManifestError message={state.message} onRetry={retry} /> |
| 286 | ) : ( |
| 287 | <p className="px-3 py-5 text-sm/6 text-muted-foreground sm:px-4"> |
| 288 | Loading open-source notices… |
| 289 | </p> |
| 290 | )} |
| 291 | </SettingsSection> |
| 292 | </SettingsPageContainer> |
| 293 | ); |
| 294 | } |