app/kb/editor-route.server.ts

Functions

Imports

It imports app/components/admin/kb-file-editor.tsx, app/kb/editor.server.ts, app/kb/form.server.ts, app/lib/admin-actor.server.ts, app/lib/context.ts. Imported by app/routes/admin.kb.entry.tsx, app/routes/admin.kb.item.tsx.

Source

1// The two editor routes' shared half (admin.kb.entry.tsx and admin.kb.item.tsx): read the file for the page, and run
2// Check or Save for its form. A save that lands redirects back to the page, so a reload never posts it twice.
3
4import { data, redirect, type RouterContextProvider } from "react-router";
5
6import type { KbEditorActionData } from "~/components/admin/kb-file-editor";
7import { adminActorContext } from "~/lib/admin-actor.server";
8import { getEnv } from "~/lib/context";
9
10import { checkFile, loadFile, saveFile, type KbTarget } from "./editor.server";
11import { duplicateEntry, formFor, rawFromForm } from "./form.server";
12
13type Args = { request: Request; context: Readonly<RouterContextProvider> };
14
15export async function kbEditorLoader({ request, context }: Args, target: KbTarget) {
16  const file = await loadFile(getEnv(context), target);
17  if (!file) throw new Response("There is no such file in the Knowledge Base.", { status: 404 });
18  const url = new URL(request.url);
19  const commit = url.searchParams.get("saved");
20  // The form is the editor; the file itself is behind Advanced (?view=file), which also works with no script at all.
21  const view = url.searchParams.get("view") === "file" ? ("file" as const) : ("form" as const);
22  return data({
23    file,
24    view,
25    form: view === "form" ? await formFor(getEnv(context), file) : null,
26    saved: commit ? { commit, unchanged: url.searchParams.get("unchanged") === "1" } : null,
27    created: url.searchParams.get("created") === "1",
28  });
29}
30
31export async function kbEditorAction({ request, context }: Args, target: KbTarget) {
32  const env = getEnv(context);
33  const form = await request.formData();
34  const intent = String(form.get("intent") ?? "");
35  const posted = form.get("model");
36
37  if (intent === "duplicate" && target.type === "entry") {
38    const file = await loadFile(env, target);
39    if (!file) throw new Response("There is no such file in the Knowledge Base.", { status: 404 });
40    const made = await duplicateEntry(
41      env,
42      { slug: target.slug, raw: file.raw },
43      { title: String(form.get("title") ?? ""), slug: String(form.get("slug") ?? "") },
44      context.get(adminActorContext),
45    );
46    if (made.outcome === "created") return redirect(`/admin/kb/entry/${made.slug}?created=1`);
47    return data<KbEditorActionData>({ intent: "duplicate", raw: "", refused: made.errors }, { status: 422 });
48  }
49
50  // From the form, the file is written from what it sent over the file it was opened from; from Advanced, it is the text.
51  let raw = String(form.get("raw") ?? "").replace(/\r\n/g, "\n");
52  const model = typeof posted === "string" ? posted : undefined;
53  if (model !== undefined) {
54    const written = rawFromForm(String(form.get("original") ?? "").replace(/\r\n/g, "\n"), model);
55    if ("errors" in written) {
56      return data<KbEditorActionData>({ intent: "check", raw: "", model, ok: false, errors: written.errors, gaps: [] }, { status: 422 });
57    }
58    raw = written.raw;
59  }
60
61  if (intent === "check") {
62    const checked = await checkFile(env, target, raw);
63    return data<KbEditorActionData>({ intent: "check", raw, model, ...checked });
64  }
65  if (intent === "save") {
66    const sha = String(form.get("sha") ?? "");
67    const result = await saveFile(env, target, raw, sha, context.get(adminActorContext));
68    if (result.outcome === "saved") {
69      const url = new URL(request.url);
70      const params = new URLSearchParams({ saved: result.commitSha.slice(0, 7) });
71      if (result.unchanged) params.set("unchanged", "1");
72      if (model === undefined) params.set("view", "file");
73      return redirect(`${url.pathname}?${params}`);
74    }
75    return data<KbEditorActionData>(
76      result.outcome === "refused" ? { intent: "save", raw, model, refused: result.errors } : { intent: "save", raw, model, conflict: result.message },
77      { status: result.outcome === "refused" ? 422 : 409 },
78    );
79  }
80  return data({ intent: "check" as const, raw, ok: false, errors: ["Unknown action."], gaps: [] }, { status: 400 });
81}