1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package web
4
5import "html/template"
6
7// View models handed to the templ components. Components only loop and
8// branch on these; the handlers build them from the use case results.
9
10// Crumb is one segment of the path in the header.
11type Crumb struct {
12 Label string
13 Href string
14 Current bool
15}
16
17// Section is a repository tab under the header, reached by its key.
18type Section struct {
19 Key string // mnemonic key
20 Label string
21 Href string
22 Current bool
23 // Count is shown after the label when it is not empty: the open merge
24 // requests.
25 Count string
26}
27
28// RefItem is a branch or tag in the ref switcher.
29type RefItem struct {
30 Name string
31 Href string
32 Current bool
33}
34
35// CmdItem is one target of the ":" command line.
36type CmdItem struct{ Kind, Label, Href string }
37
38// Layout is the input of the page shell.
39type Layout struct {
40 Title string
41 // Owner is the owner's name (ERMITE_OWNER), shown when signed in.
42 Owner string
43 Version string
44 SourceURL string
45 Assets Assets
46 Crumbs []Crumb
47 Ref string // ref shown in the header, "" outside a repo view
48 Short string // short sha shown after the ref
49 Sections []Section
50 Repo string
51 SHA string // full sha of the ref, for the permalink key
52 RefPath string // the URL segment that `y` rewrites: the ref name
53 Heads []RefItem
54 Tags []RefItem
55 Cmd []CmdItem
56 HasRail bool
57 // Lede is a line above the content and the rail, so both start level.
58 Lede string
59 // Live connects the page to the event stream (/-/events).
60 Live bool
61 // LiveURL is the stream the page follows, with its query.
62 LiveURL string
63 // PathsURL is the list of the file paths of the commit the page shows
64 // (/{repo}/paths/{sha}) and BlobBase the URL its file links start with;
65 // both are "" when the page has no commit to search.
66 PathsURL, BlobBase string
67 // Passkeys tells that the passkey routes exist: the header then links to
68 // them.
69 Passkeys bool
70 // MR loads the script of the merge request page (mr.js).
71 MR bool
72}
73
74// Link is a plain label + href pair.
75type Link struct{ Label, Href string }
76
77// HomeRow is one repository in the home list.
78type HomeRow struct {
79 ID string
80 Name string
81 Href string
82 Desc string
83 Pushed string
84 PushedAt string // RFC 3339, "" when never pushed
85 Branch string
86 Cursor bool
87 // Private marks a private repository; only set for a signed-in visitor.
88 Private bool
89 // Fresh marks a row that a push just updated (live updates only).
90 Fresh bool
91 // Commits are the newest of the default branch. NoCommits says there is
92 // none (never pushed, or an empty branch); a failed read says nothing.
93 Commits []CommitRow
94 NoCommits bool
95 // CI is the latest run of the default branch, nil when there is none to
96 // show.
97 CI *HomeCI
98}
99
100// HomeCI is the state of the latest run of the default branch of a repository.
101type HomeCI struct {
102 Href string
103 Kind string // the mark: ok, bad, running, queued, skipped, cancelled
104 Label string // the word next to it
105 Title string
106}
107
108// SortLink is one way to order the home list; it links to that order.
109type SortLink struct {
110 Label string
111 Href string
112 Mark string // "▲" or "▼" on the current order, "" otherwise
113 // State says the current direction and what the link does, for screen
114 // readers (the mark is hidden from them); "" off the current order.
115 State string
116}
117
118// HomePage is the repository list.
119type HomePage struct {
120 Sorts []SortLink
121 Rows []HomeRow
122}
123
124// Fact is one key/value row of the facts block.
125type Fact struct {
126 Key, Val, ID, Time string
127}
128
129// Clone is a block of copyable shell lines, one [copy] button per line.
130type Clone struct {
131 ID string
132 Lines []string
133}
134
135// Heading is one README outline entry.
136type Heading struct {
137 Level int
138 ID string
139 Text string
140}
141
142// Readme is a rendered README. HTML comes from the Markdown renderer (raw
143// HTML dropped, URLs filtered) or is escaped plain text.
144type Readme struct {
145 Name string
146 HTML template.HTML
147 // Note replaces the content when the file is not rendered (too large).
148 Note string
149}
150
151// CommitRow is one commit in the commit table.
152type CommitRow struct {
153 ID string
154 Short string
155 Subject string
156 CHref string
157 Author string
158 When string
159 WhenAt string
160 Merge bool
161 Branches []string
162 Tags []string
163 Cursor bool
164 // Checks is the combined state of the CI checks of the commit; empty when
165 // it has none.
166 Checks ChecksSummary
167}
168
169// SummaryPage is the repository summary.
170type SummaryPage struct {
171 Facts []Fact
172 Clone Clone
173 Recent []CommitRow
174 Readme *Readme
175 Outline []Heading
176 AllHref string
177 // Latest is the newest tag, nil when the repository has none.
178 Latest *LatestTag
179 // Actions is the recent runs of the rail, nil when the viewer cannot read
180 // CI (or the server runs none).
181 Actions *RecentActions
182}
183
184// RecentActions is the "Recent actions" block of the summary rail: the newest
185// runs. With no run the block is in the page but hidden, so that the first
186// run reaches it live.
187type RecentActions struct {
188 Runs []RunRow
189 AllHref string
190}
191
192// LatestTag is the newest tag of a repository, shown in the summary rail.
193// Name is empty when there are too many tags to date them; Count and
194// RefsHref still lead to the full list.
195type LatestTag struct {
196 Name, Href, Subject, When, WhenAt string
197 Count int
198 RefsHref string
199}
200
201// RefRow is a branch or a tag in the refs table.
202type RefRow struct {
203 Name, Href, Short, CHref, Subject, When, WhenAt string
204 Default, Cursor bool
205 // Checks is the combined state of the CI checks of the commit.
206 Checks ChecksSummary
207}
208
209// RefsPage lists the branches and tags of a repository.
210type RefsPage struct {
211 Branches []RefRow
212 Tags []RefRow
213 Latest string
214 Default string
215 // Note says the lists were cut.
216 Note string
217}
218
219// StatePage is a 404, 500 or empty-repository state.
220type StatePage struct {
221 Code string // "404", "500", "empty"
222 Title string
223 Lines []string
224 Clone *Clone
225 Back []Link
226}
227
228// LoginPage is the confirmation of a login link: a form with one button.
229type LoginPage struct {
230 Title string
231 Lines []string
232 Action string // where the form posts
233 Button string
234}
235
236// PasskeyLoginPage is the sign-in page: one button the script drives.
237type PasskeyLoginPage struct {
238 Title string
239 Lines []string
240 Button string
241 // Begin and Finish are the endpoints the script posts to.
242 Begin, Finish string
243}
244
245// PasskeyRow is one passkey on the passkeys page.
246type PasskeyRow struct {
247 Name string
248 // Created and LastUsed are relative ("3d ago"); the At fields are the
249 // RFC 3339 forms, "" when never.
250 Created, CreatedAt string
251 LastUsed, LastUsedAt string
252 Synced bool
253 // Remove is where the remove form posts.
254 Remove string
255}
256
257// PasskeysPage lists the passkeys and adds one.
258type PasskeysPage struct {
259 Rows []PasskeyRow
260 Begin, Finish string
261 // Full tells that no more passkeys can be added.
262 Full bool
263 Max int
264}