components/mentions-list/mentions-list.ts

Functions

Imports

It imports components/content/content.ts, components/moderation-queue/moderation-queue.ts. Imported by components/mentions-list/examples.tsx, components/mentions-list/mentions-list.react.tsx.

Source

1// The mentions list's pure helpers: the addresses of its tabs and pages, which view it opens on,
2// which actions a person is offered here and why the others are withheld, the count and the empty
3// state. The states, their words and the decisions are the moderation queue's (moderation-queue.ts),
4// which the list is built from. No DOM; the React component and a server render use the same
5// functions.
6import { queryHref, type MentionsData, type MentionsQuery } from "../content/content.ts";
7import { EMPTY_TEXT, VIEWS, bulkActionsFor, mentionsWord, type ModAction, type ModView } from "../moderation-queue/moderation-queue.ts";
8
9// ---------------------------------------------------------------------------------------
10// Addresses.
11
12const QUERY_ORDER: ReadonlyArray<keyof MentionsQuery> = ["view", "cursor", "open"];
13
14// The list's address with a query (content.ts, queryHref).
15export function mentionsHref(base: string, q: MentionsQuery): string {
16  return queryHref(base, q, QUERY_ORDER);
17}
18
19// A tab change starts again at the first page with nothing open; opening a mention keeps the
20// page it is on.
21export function withMentions(q: MentionsQuery, change: Partial<MentionsQuery>): MentionsQuery {
22  const next: MentionsQuery = { ...q, ...change };
23  if (!("open" in change)) {
24    delete next.cursor;
25    delete next.open;
26  }
27  for (const k of Object.keys(change) as Array<keyof MentionsQuery>) if (change[k] === undefined) delete next[k];
28  return next;
29}
30
31// The tab shown: the one asked for, else Waiting, else All when nothing waits (Carrel and
32// dustinedwards.info already agree on this).
33export function currentView(data: Pick<MentionsData, "query" | "counts">): ModView {
34  const v = data.query.view;
35  if (v && (VIEWS as readonly string[]).includes(v)) return v;
36  return data.counts.pending > 0 ? "pending" : "all";
37}
38
39// ---------------------------------------------------------------------------------------
40// What is offered.
41
42export type MentionIntent = ModAction | "delete";
43
44export interface OfferedAction {
45  intent: MentionIntent;
46  label: string;
47  destructive?: boolean;
48}
49
50const BULK_LABEL: Record<MentionIntent, string> = { approve: "Approve", reject: "Reject", reset: "Back to waiting", delete: "Delete" };
51
52// The bulk actions this person may run on this tab of this site, in the bar's order, and a
53// sentence for each one held back.
54export function mentionActions(data: Pick<MentionsData, "offers" | "can" | "query" | "counts">): { bulk: OfferedAction[]; withheld: string[] } {
55  const { offers, can } = data;
56  const view = currentView(data);
57  const bulk: OfferedAction[] = [];
58  const withheld: string[] = [];
59  if (can.decideMentions) for (const a of bulkActionsFor(view, offers.reset)) bulk.push({ intent: a, label: BULK_LABEL[a] });
60  if (can.decideMentions && offers.delete) bulk.push({ intent: "delete", label: "Delete", destructive: true });
61  if (!can.decideMentions) withheld.push("You can read these mentions. Deciding them needs the site owner's role.");
62  else {
63    if (!offers.delete) withheld.push("Delete is not offered: this site keeps every mention. Reject one to keep it off its post.");
64    if (!offers.reset) withheld.push("Back to waiting is not offered by this site, so a decision on a waiting mention has no Undo.");
65  }
66  return { bulk, withheld };
67}
68
69// ---------------------------------------------------------------------------------------
70// Words.
71
72// "4 mentions", "Showing 50 of 212 mentions".
73export function countLine(data: Pick<MentionsData, "rows" | "query" | "counts">): string {
74  const n = data.rows.length;
75  const total = data.counts[currentView(data)];
76  return total > n ? `Showing ${n} of ${total} ${mentionsWord(total)}` : `${n} ${mentionsWord(n)}`;
77}
78
79export function emptyWords(view: ModView): { kind: "all-clear" | "nothing-yet"; title: string; text: string } {
80  return { kind: view === "pending" ? "all-clear" : "nothing-yet", ...EMPTY_TEXT[view] };
81}
82
83// The sweep's button: "Remove 3 expired".
84export function sweepLabel(expiring: MentionsData["expiring"]): { n: number; label: string } {
85  const n = expiring.failed + expiring.rejected;
86  return { n, label: `Remove ${n} expired` };
87}