app/lib/sites.server.ts

Functions

Imports

It imports app/lib/timed-fetch.server.ts. Imported by app/lib/ai.server.ts, app/lib/bulk.server.ts, app/lib/content.server.ts, app/lib/google/refresh.server.ts, app/lib/google/search-console.server.ts, app/lib/health.server.ts, app/lib/history.server.ts, app/lib/index.server.ts, app/lib/legal.server.ts, app/lib/mcp/tools.ts, app/lib/media.server.ts, app/lib/mentions.server.ts, app/lib/projects.server.ts, app/lib/refresh.server.ts, app/lib/voice.server.ts, app/routes/ai-draft.preview.ts, app/routes/editor.tsx, app/routes/history.tsx, app/routes/legal.tsx, app/routes/media.api.ts, app/routes/media.bulk.ts, app/routes/media.tsx, app/routes/mentions.tsx, app/routes/preview.ts, app/routes/project.flags.tsx, app/routes/project.new.tsx, app/routes/project.tsx, app/routes/project.voice.tsx, app/routes/unpublish.tsx, workers/app.ts.

Source

1// The sites Carrel reaches through site-api, and the client for one. A site's origin is config and
2// its key is a secret; Carrel holds nothing else about a site and never reads its repository.
3
4import { createSiteClient, type SiteClient } from "@dustinedwards/site-api/client";
5import { MIN_KEY_LENGTH } from "@dustinedwards/site-api";
6import { timedFetch } from "~/lib/timed-fetch.server";
7
8export type SiteId = "dustinedwards" | "germomics" | "foxhound" | "foxing" | "txasm" | "julieedwards";
9
10type SiteEntry = {
11  name: string;
12  origin: (env: Env) => string | undefined;
13  key: (env: Env) => string | undefined;
14  keyName: string;
15  /**
16   * The source a new item starts from, in the site's own frontmatter. The site validates it on save.
17   * Absent for a site with a fixed set of items, which refuses a new id: Carrel then offers no New post.
18   */
19  newSource?: (slug: string, today: string) => string;
20  /**
21   * Items other code on the site depends on staying public. dustinedwards.info's terms are the license
22   * named by the Dataset JSON-LD and the Link header on every download, so Carrel never takes them down.
23   */
24  keepPublic: readonly string[];
25  /** The Search Console property the service account reads for the site's pages. */
26  searchConsoleProperty: (env: Env) => string;
27};
28
29const SITES: Record<SiteId, SiteEntry> = {
30  dustinedwards: {
31    name: "dustinedwards.info",
32    origin: (env) => env.SITE_DUSTINEDWARDS_ORIGIN,
33    key: (env) => env.SITE_DUSTINEDWARDS_KEY,
34    keyName: "SITE_DUSTINEDWARDS_KEY",
35    keepPublic: ["page.terms"],
36    // The shape of content/posts/*.md on the site: draft until the Owner publishes.
37    newSource: (slug, today) =>
38      ["---", 'title: ""', `slug: ${slug}`, 'description: ""', `date: ${today}`, "tags: []", "draft: true", "---", "", ""].join("\n"),
39    searchConsoleProperty: (env) => env.SEARCH_CONSOLE_PROPERTY_DUSTINEDWARDS?.trim() || "sc-domain:dustinedwards.info",
40  },
41  germomics: {
42    name: "Germomics",
43    origin: (env) => env.SITE_GERMOMICS_ORIGIN,
44    key: (env) => env.SITE_GERMOMICS_KEY,
45    keyName: "SITE_GERMOMICS_KEY",
46    keepPublic: [],
47    // The shape of germomics's app/lib/carrel/source.ts: JSON front matter, then the article body as
48    // the site's own HTML. The id is the slug, and an item the site has not seen is created a draft.
49    newSource: () => ["---", 'title: ""', 'excerpt: ""', "tags: []", "---", ""].join("\n"),
50    searchConsoleProperty: (env) => (env as { SEARCH_CONSOLE_PROPERTY_GERMOMICS?: string }).SEARCH_CONSOLE_PROPERTY_GERMOMICS?.trim() || "sc-domain:germomics.com",
51  },
52  foxhound: {
53    name: "Foxhound",
54    origin: (env) => env.SITE_FOXHOUND_ORIGIN,
55    key: (env) => env.SITE_FOXHOUND_KEY,
56    keyName: "SITE_FOXHOUND_KEY",
57    keepPublic: [],
58    // The shape of foxhound's app/lib/carrel/source.ts: one JSON value per front matter line, then the
59    // post's Markdown body. The slug is the address given here; the site refuses a later change to it.
60    newSource: (slug) =>
61      ["---", 'title: ""', `slug: ${JSON.stringify(slug)}`, 'excerpt: ""', 'author: "Foxhound"', "tags: []", "featured: false", "---", ""].join("\n"),
62    searchConsoleProperty: (env) => (env as { SEARCH_CONSOLE_PROPERTY_FOXHOUND?: string }).SEARCH_CONSOLE_PROPERTY_FOXHOUND?.trim() || "sc-domain:foxhoundapp.com",
63  },
64  foxing: {
65    name: "Foxing",
66    origin: (env) => env.SITE_FOXING_ORIGIN,
67    key: (env) => env.SITE_FOXING_KEY,
68    keyName: "SITE_FOXING_KEY",
69    keepPublic: [],
70    // The shape of foxing's apps/web/app/lib/carrel/journal-source.ts for a Journal post: every field
71    // as JSON, a blank line, then the Markdown body. The id is the slug; a new post is created a draft.
72    newSource: () =>
73      ["---", 'title: ""', "excerpt: null", "cover_image_url: null", "cover_image_alt: null", "tags: []", "featured: false", "---", "", ""].join("\n"),
74    searchConsoleProperty: (env) => (env as { SEARCH_CONSOLE_PROPERTY_FOXING?: string }).SEARCH_CONSOLE_PROPERTY_FOXING?.trim() || "sc-domain:foxing.app",
75  },
76  txasm: {
77    name: "Texas Branch ASM",
78    origin: (env) => env.SITE_TXASM_ORIGIN,
79    key: (env) => env.SITE_TXASM_KEY,
80    keyName: "SITE_TXASM_KEY",
81    keepPublic: ["home", "award-nominations"],
82    searchConsoleProperty: (env) => env.SEARCH_CONSOLE_PROPERTY_TXASM?.trim() || "sc-domain:txasm.org",
83  },
84  julieedwards: {
85    name: "julieedwards.info",
86    origin: (env) => env.SITE_JULIEEDWARDS_ORIGIN,
87    key: (env) => env.SITE_JULIEEDWARDS_KEY,
88    keyName: "SITE_JULIEEDWARDS_KEY",
89    keepPublic: ["profile", "priorities", "about", "experience", "contact", "site"],
90    searchConsoleProperty: (env) => env.SEARCH_CONSOLE_PROPERTY_JULIEEDWARDS?.trim() || "sc-domain:julieedwards.info",
91  },
92};
93
94export const SITE_IDS = Object.keys(SITES) as SiteId[];
95
96export function isSiteId(value: string | null | undefined): value is SiteId {
97  return typeof value === "string" && Object.hasOwn(SITES, value);
98}
99
100export function siteEntry(id: SiteId): SiteEntry {
101  return SITES[id];
102}
103
104export type SiteConnection =
105  | { state: "connected"; origin: string; key: string }
106  | { state: "not-connected"; detail: string }
107  | { state: "misconfigured"; detail: string };
108
109/**
110 * No key is "not connected": the site's stage has not arrived (setup step 10). A key without an
111 * origin, a short key, or a malformed origin is misconfigured, which the health check reports.
112 */
113export function siteConnection(env: Env, id: SiteId): SiteConnection {
114  const entry = SITES[id];
115  const key = entry.key(env)?.trim() ?? "";
116  const origin = entry.origin(env)?.trim() ?? "";
117  if (!key) return { state: "not-connected", detail: `No ${entry.keyName} set.` };
118  if (key.length < MIN_KEY_LENGTH) {
119    return { state: "misconfigured", detail: `${entry.keyName} is shorter than ${MIN_KEY_LENGTH} characters.` };
120  }
121  let url: URL;
122  try {
123    url = new URL(origin);
124  } catch {
125    return { state: "misconfigured", detail: `The origin for ${entry.name} is missing or not a URL.` };
126  }
127  if (url.protocol !== "https:") {
128    return { state: "misconfigured", detail: `The origin for ${entry.name} is not https.` };
129  }
130  return { state: "connected", origin: url.origin, key };
131}
132
133/**
134 * Where a browser loads a site's file from. The site gives a path on itself (/media/...) or a full
135 * https URL; a path is made absolute on the site's origin, since Carrel is a different host. The
136 * Markdown keeps the site's own form, which is what the site serves and its reference check reads.
137 */
138export function absoluteMediaUrl(origin: string, url: string): string {
139  return url.startsWith("/") ? `${origin.replace(/\/+$/, "")}${url}` : url;
140}
141
142/** Every configured site origin, for the image policy: a thumbnail loads from the site that serves it. */
143export function siteOrigins(env: Env): string[] {
144  const origins: string[] = [];
145  for (const id of SITE_IDS) {
146    try {
147      const url = new URL(SITES[id].origin(env)?.trim() ?? "");
148      if (url.protocol === "https:") origins.push(url.origin);
149    } catch {
150      // Not configured: nothing of it is loaded.
151    }
152  }
153  return origins;
154}
155
156export class SiteNotConnected extends Error {
157  constructor(readonly detail: string) {
158    super(detail);
159    this.name = "SiteNotConnected";
160  }
161}
162
163/** Throws SiteNotConnected when the site cannot be reached, so callers show why instead of a 500. */
164export function siteClient(env: Env, id: SiteId, fetcher?: typeof fetch): SiteClient {
165  const connection = siteConnection(env, id);
166  if (connection.state !== "connected") throw new SiteNotConnected(connection.detail);
167  return createSiteClient({ baseUrl: connection.origin, key: connection.key, fetch: fetcher ?? timedFetch });
168}