@learnpack/learnpack 5.0.357 → 5.0.358

package/src/utils/branding.ts

@@ -0,0 +1,78 @@
+/**
+ * Branding used by link previews (Open Graph / Twitter cards).
+ *
+ * Both the draft server and the publish pipeline need an absolute image URL for
+ * `og:image`, and drafts additionally need copy that says nothing about the
+ * course they belong to.
+ */
+
+/**
+ * Where `learnpack serve` runs in production. It is only a fallback: the server
+ * itself already has the real origin in `process.env.HOST` (it uses it to build
+ * webhook URLs). The `publish` command, however, runs on the author's machine
+ * with no such variable, and still has to write an absolute `og:image` into the
+ * package it uploads.
+ */
+export const PRODUCTION_PUBLIC_HOST = "https://app.learnpack.co"
+
+/**
+ * Strips what `.env` files routinely smuggle in — a trailing comment, quotes,
+ * stray whitespace, a trailing slash — the same way `serve` sanitises `HOST`.
+ * @param raw - The raw environment value, if set.
+ * @returns The cleaned value, or an empty string.
+ */
+function normalizeOrigin(raw?: string): string {
+  if (!raw) {
+    return ""
+  }
+
+  return raw
+    .trim()
+    .split(/\s+#/)[0]
+    .trim()
+    .replace(/["']/g, "")
+    .replace(/\/+$/, "")
+}
+
+/**
+ * Public origin of the app server, without a trailing slash.
+ *
+ * Only an absolute http(s) origin is accepted. `HOST` is also the conventional
+ * name for a bind address, so a deployment that sets it to `0.0.0.0` would
+ * otherwise yield a relative `og:image` — which no crawler can resolve, and
+ * which would be baked into every package published from that machine.
+ * @returns The origin to build absolute preview URLs from.
+ */
+export function getPublicHost(): string {
+  for (const raw of [process.env.PUBLIC_HOST, process.env.HOST]) {
+    const cleaned = normalizeOrigin(raw)
+    if (/^https?:\/\/\S+$/.test(cleaned)) {
+      return cleaned
+    }
+  }
+
+  return PRODUCTION_PUBLIC_HOST
+}
+
+/**
+ * Neutral brand card, used as `og:image` when a course has no preview of its own.
+ *
+ * It has to be a raster image: no unfurl crawler renders SVG. The previous
+ * fallback pointed at `learnpack.svg` on raw.githubusercontent.com, which fails
+ * twice over — SVG is unsupported, and that host serves it as `text/plain` with
+ * `X-Content-Type-Options: nosniff`.
+ */
+export function getFallbackPreviewUrl(): string {
+  return `${getPublicHost()}/og-image.png`
+}
+
+/**
+ * Copy for the link preview of a draft course.
+ *
+ * A draft is unlisted work in progress, so the card carries branding only: it
+ * must not disclose the title, the description or anything else about the
+ * course, and the pages that use it are served `noindex`.
+ */
+export const DRAFT_PREVIEW_TITLE = "LearnPack — Draft course"
+export const DRAFT_PREVIEW_DESCRIPTION =
+  "This course is still a draft and is not published yet."