| 1 | /** |
| 2 | * Which frame a page is drawn in. |
| 3 | * |
| 4 | * - `standalone`: signing in, signing up and choosing a workspace. The |
| 5 | * page alone, centred, with the logo and a quiet row of links at the |
| 6 | * foot: no header, no sidebar, no rail. |
| 7 | * - `app`: someone signed in, everywhere else. The rail, the mode's |
| 8 | * sidebar and the page in its panel, always about their current |
| 9 | * workspace, even on public pages such as Explore, a profile or another |
| 10 | * workspace's public project. |
| 11 | * - `public`: a visitor who is not signed in (or has not confirmed their |
| 12 | * address yet), on every other page: a plain header with the logo, |
| 13 | * Explore, Docs and signing in, the page at full width, and the footer. |
| 14 | */ |
| 15 | |
| 16 | import type { Abilities, Capability } from "@g1t/contracts"; |
| 17 | |
| 18 | export type Frame = "standalone" | "public" | "app"; |
| 19 | |
| 20 | /** Pages that are drawn on their own, whoever opens them. */ |
| 21 | const STANDALONE = new Set([ |
| 22 | "/login", |
| 23 | "/login/two-factor", |
| 24 | "/register", |
| 25 | "/logout", |
| 26 | "/verify", |
| 27 | "/confirm-email", |
| 28 | "/forgot", |
| 29 | "/reset", |
| 30 | "/device", |
| 31 | "/oauth/authorize", |
| 32 | "/workspaces/new", |
| 33 | "/integrations/github/setup", |
| 34 | ]); |
| 35 | |
| 36 | /** Marketing pages: the public header and footer, even for someone signed in. */ |
| 37 | const MARKETING = new Set(["/download", "/features"]); |
| 38 | |
| 39 | /** The page's path without a trailing slash or a click's `.data`. */ |
| 40 | function framePath(pathname: string): string { |
| 41 | const path = pathname.replace(/\.data$/, ""); |
| 42 | return path.length > 1 ? path.replace(/\/+$/, "") : path; |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * The frame for `pathname`. `viewer` says whether someone is signed in and |
| 47 | * confirmed (`signedIn`), and whether they belong to a workspace yet: until |
| 48 | * they do, answering an invitation is part of getting started too. |
| 49 | */ |
| 50 | export function frameOf(pathname: string, viewer: { signedIn: boolean; workspace: boolean }): Frame { |
| 51 | const path = framePath(pathname); |
| 52 | if (STANDALONE.has(path)) return "standalone"; |
| 53 | // Marketing pages are the site's front, whoever reads them: never inside the app's rail and sidebar. |
| 54 | if (MARKETING.has(path)) return "public"; |
| 55 | // An invite link, signing in with GitHub, and a workspace's single sign-on are the front door. |
| 56 | if (path.startsWith("/invite/") || path === "/auth/github" || path.startsWith("/auth/github/") || path.startsWith("/auth/sso/")) { |
| 57 | return "standalone"; |
| 58 | } |
| 59 | if (path === "/invitations" && viewer.signedIn && !viewer.workspace) return "standalone"; |
| 60 | return viewer.signedIn ? "app" : "public"; |
| 61 | } |
| 62 | |
| 63 | /** The project pages the sidebar lists, by key, for a member or not. */ |
| 64 | export type ProjectPage = |
| 65 | | "code" |
| 66 | | "pulls" |
| 67 | | "actions" |
| 68 | | "deployments" |
| 69 | | "observability" |
| 70 | | "security" |
| 71 | | "insights" |
| 72 | | "secrets" |
| 73 | | "environments" |
| 74 | | "domains" |
| 75 | | "runners" |
| 76 | | "webhooks" |
| 77 | | "storage" |
| 78 | | "daemons" |
| 79 | | "settings"; |
| 80 | |
| 81 | /** |
| 82 | * What a page needs beyond a role on the repository, once what the viewer |
| 83 | * may do is known: Security's findings are for people who can push. |
| 84 | */ |
| 85 | export const PROJECT_OPERATIONS = ["secrets", "environments", "domains", "runners", "webhooks"] as const; |
| 86 | |
| 87 | export const PAGE_NEEDS: Partial<Record<ProjectPage, Capability>> = { |
| 88 | security: "push", |
| 89 | secrets: "manage_integrations", |
| 90 | environments: "manage_integrations", |
| 91 | domains: "manage_integrations", |
| 92 | runners: "manage_integrations", |
| 93 | webhooks: "manage_integrations", |
| 94 | }; |
| 95 | |
| 96 | /** |
| 97 | * A project's menu, in order. Security and Settings are for people with a |
| 98 | * role on its repository, and a page in `PAGE_NEEDS` only for those whose |
| 99 | * role has its capability (`can`, once the repository's page has loaded); |
| 100 | * everyone who can see the project sees the rest. |
| 101 | */ |
| 102 | export function projectPages(member: boolean, can?: Partial<Abilities>): ProjectPage[] { |
| 103 | const pages: (ProjectPage | false)[] = [ |
| 104 | "code", |
| 105 | "pulls", |
| 106 | "actions", |
| 107 | // A public repository's deployments and build logs are for anyone, as its code is. |
| 108 | "deployments", |
| 109 | // Logs and requests are not: they can hold what only the people running it should read. |
| 110 | member && "observability", |
| 111 | member && "security", |
| 112 | "insights", |
| 113 | ...PROJECT_OPERATIONS.map((page) => member && page), |
| 114 | member && "storage", |
| 115 | member && "daemons", |
| 116 | member && "settings", |
| 117 | ]; |
| 118 | return pages.filter((page): page is ProjectPage => page !== false && (!can || !PAGE_NEEDS[page] || Boolean(can[PAGE_NEEDS[page]!]))); |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * A project's pages as the phone's strip of tabs under its name names them |
| 123 | * (routes/repo/layout.tsx): the sidebar's words, and the paths under the |
| 124 | * project at which each is the current one. |
| 125 | */ |
| 126 | export const PROJECT_PAGE_LINKS: Record<ProjectPage, { label: string; path: string; also: string[]; soon?: boolean; outside?: boolean }> = { |
| 127 | code: { label: "Code", path: "code", also: ["tree", "blob", "commits", "commit", "branches", "tags", "releases", "compare"] }, |
| 128 | pulls: { label: "Pull requests", path: "pulls", also: ["pull", "queue"] }, |
| 129 | actions: { label: "Workflows", path: "actions", also: [] }, |
| 130 | deployments: { label: "Deployments", path: "deployments", also: ["settings/deployments"] }, |
| 131 | observability: { label: "Observability", path: "observability", also: [] }, |
| 132 | security: { label: "Security", path: "security", also: [] }, |
| 133 | insights: { label: "Insights", path: "contributors", also: ["activity", "stargazers"] }, |
| 134 | secrets: { label: "Environment variables", path: "settings/secrets", also: [] }, |
| 135 | environments: { label: "Environments", path: "settings/environments", also: [] }, |
| 136 | domains: { label: "Domains", path: "settings/domains", also: [] }, |
| 137 | runners: { label: "Runners", path: "settings/runners", also: [] }, |
| 138 | webhooks: { label: "Webhooks", path: "settings/webhooks", also: [] }, |
| 139 | storage: { label: "Storage", path: "soon/storage", also: [], soon: true }, |
| 140 | daemons: { label: "Daemons", path: "soon/daemons", also: [], soon: true }, |
| 141 | settings: { label: "Settings", path: "settings", also: [] }, |
| 142 | }; |
| 143 | |
| 144 | /** |
| 145 | * Which of a project's pages `rest` (the path under the project, no |
| 146 | * leading slash) is on: "overview" for the project itself. `soon` says |
| 147 | * which page a roadmap page (`soon/<key>`) sits under. |
| 148 | */ |
| 149 | export function projectPageAt(rest: string, soon: Record<string, ProjectPage> = {}): ProjectPage | "overview" | null { |
| 150 | const path = rest.replace(/^\/+|\/+$/g, ""); |
| 151 | if (path === "") return "overview"; |
| 152 | const soonKey = /^soon\/([^/]+)/.exec(path)?.[1]; |
| 153 | if (soonKey && soon[soonKey]) return soon[soonKey]!; |
| 154 | for (const [page, link] of Object.entries(PROJECT_PAGE_LINKS) as [ProjectPage, (typeof PROJECT_PAGE_LINKS)[ProjectPage]][]) { |
| 155 | if ([link.path, ...link.also].some((prefix) => path === prefix || path.startsWith(`${prefix}/`))) return page; |
| 156 | } |
| 157 | return null; |
| 158 | } |