app/lib/editor/feedback.ts

Functions

Imports

It imports app/lib/editor/publish-policy.mjs. Imported by app/components/admin/editor-bar.tsx, app/components/admin/post-editor.tsx, app/components/admin/use-draft-buffer.ts, app/routes/admin.posts.$slug.edit.tsx, app/routes/admin.posts.new.tsx.

Source

1// Success crosses the post/redirect/get in the URL; a failure cannot, because the redirect would
2// discard the typed body. The URL is editable, so everything parsed from it is untrusted.
3
4import type { SaveOutcome } from "./publish-policy.mjs";
5
6export type EditorFeedback =
7  | { state: "saved"; sha: string }
8  | { state: "published-first"; sha: string; at: string; slug: string }
9  | { state: "republished"; sha: string; slug: string }
10  | { state: "unpublished"; sha: string; slug: string }
11  | { state: "failed"; message: string; conflict: boolean; field?: string; line?: number };
12
13const OUTCOMES: readonly SaveOutcome[] = [
14  "saved",
15  "published-first",
16  "republished",
17  "unpublished",
18];
19
20function shortSha(sha: string) {
21  return sha.slice(0, 7);
22}
23
24export function savedRedirectPath(result: {
25  slug: string;
26  outcome: SaveOutcome;
27  commitSha: string;
28  firstPublished: string | null;
29}) {
30  const params = new URLSearchParams({
31    saved: result.outcome,
32    sha: shortSha(result.commitSha),
33  });
34  if (result.outcome === "published-first" && result.firstPublished) {
35    params.set("at", result.firstPublished);
36  }
37  return `/admin/posts/${result.slug}/edit?${params}`;
38}
39
40export function feedbackFromSearch(
41  search: URLSearchParams,
42  slug: string,
43): EditorFeedback | null {
44  const outcome = search.get("saved");
45  const sha = search.get("sha") ?? "";
46  if (!outcome || !(OUTCOMES as readonly string[]).includes(outcome)) return null;
47  if (!/^[0-9a-f]{7,40}$/.test(sha)) return null;
48
49  switch (outcome as SaveOutcome) {
50    case "published-first": {
51      const at = search.get("at") ?? "";
52      if (!/^\d{4}-\d{2}-\d{2}$/.test(at)) return { state: "saved", sha };
53      return { state: "published-first", sha, at, slug };
54    }
55    case "republished":
56      return { state: "republished", sha, slug };
57    case "unpublished":
58      return { state: "unpublished", sha, slug };
59    default:
60      return { state: "saved", sha };
61  }
62}