blume 2.0.2 → 2.1.0

package/src/components/content/api-page.ts

@@ -0,0 +1,224 @@
+import type { ParameterLike, SchemaLike } from "../openapi/helpers.ts";
+import { resolveSecurity } from "../openapi/security.ts";
+import type { OperationSecurity } from "../openapi/security.ts";
+import type { FieldValue, ParamLocation } from "./api-field.ts";
+
+/**
+ * A hand-written API page's endpoint, as its `api` frontmatter and its
+ * `<ParamField>`s describe it, turned into the OpenAPI-shaped pieces the
+ * operation playground and code samples are built from: a page with
+ * `api: "POST /v1/users"` gets the same Try it panel and request samples as
+ * a spec'd operation, with no spec. Mintlify's frontmatter, so migrated pages
+ * keep it as written.
+ */
+
+/** How a hand-written endpoint authenticates (`authMethod`, `api.auth.method`). */
+export const AUTH_METHODS = ["bearer", "basic", "key", "none"] as const;
+export type AuthMethod = (typeof AUTH_METHODS)[number];
+
+/** What a page's playground shows: all of it, the samples only, or none. */
+export const PLAYGROUND_MODES = ["interactive", "simple", "none"] as const;
+export type PlaygroundMode = (typeof PLAYGROUND_MODES)[number];
+
+/** `api` frontmatter: an HTTP method, then a path or a full URL. */
+export const API_ENDPOINT =
+  /^(?<method>GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS|TRACE)\s+(?<target>\S+)$/iu;
+
+/** The site's default auth for hand-written endpoints (`api.auth`). */
+export interface EndpointAuth {
+  method: AuthMethod;
+  /** The header an API key goes in. */
+  name?: string;
+}
+
+/** One `<ParamField>`, as the page's plugin collected it. */
+export interface EndpointField {
+  default?: FieldValue;
+  deprecated?: boolean;
+  /** Body fields nested in this one's `<Expandable>`. */
+  fields?: EndpointField[];
+  location: ParamLocation;
+  name: string;
+  placeholder?: string;
+  required?: boolean;
+  type?: string;
+}
+
+/** What the page's plugin hands the endpoint components. */
+export interface EndpointSpec {
+  authMethod?: AuthMethod;
+  fields: EndpointField[];
+  method: string;
+  playground?: PlaygroundMode;
+  /** The page has a `<RequestExample>`, which stands in for generated samples. */
+  requestExample: boolean;
+  /** The `api` target as written: a path, or a full URL. */
+  target: string;
+}
+
+/** The method and target of an `api` value, or `null` when it isn't one. */
+export const parseApiEndpoint = (
+  value: string
+): { method: string; target: string } | null => {
+  const groups = API_ENDPOINT.exec(value.trim())?.groups;
+  return groups?.method && groups.target
+    ? { method: groups.method.toUpperCase(), target: groups.target }
+    : null;
+};
+
+const ABSOLUTE_URL = /^(?<origin>https?:\/\/[^/?#]+)(?<rest>.*)$/iu;
+
+/** An endpoint's target, split the way the operation model takes it. */
+export interface EndpointTarget {
+  path: string;
+  servers: { url: string }[];
+}
+
+/**
+ * The target split into a server and a path: a full URL is its own server,
+ * and a path joins the site's `api.server`, or stays relative to the docs
+ * when there is none.
+ */
+export const endpointTarget = (
+  target: string,
+  server?: string
+): EndpointTarget => {
+  const absolute = ABSOLUTE_URL.exec(target)?.groups;
+  if (absolute?.origin) {
+    return {
+      path: absolute.rest || "/",
+      servers: [{ url: absolute.origin }],
+    };
+  }
+  return {
+    path: target.startsWith("/") ? target : `/${target}`,
+    servers: server ? [{ url: server.replace(/\/+$/u, "") }] : [],
+  };
+};
+
+const PRIMITIVES = new Set([
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "object",
+]);
+
+/**
+ * A field's JSON schema from its `type`: `string[]` an array of strings, a
+ * field with nested fields an object with those properties, and anything
+ * that isn't a JSON type (`enum<string>`, `Date`) a string, which is what it
+ * goes over the wire as. A default and placeholder carry over, the
+ * placeholder as the example the samples show.
+ */
+export const fieldSchema = (field: EndpointField): SchemaLike => {
+  const type = field.type?.trim().toLowerCase() ?? "";
+  if (type.endsWith("[]")) {
+    return {
+      items: fieldSchema({
+        ...field,
+        default: undefined,
+        type: type.slice(0, -2),
+      }),
+      type: "array",
+    };
+  }
+  const nested = field.fields ?? [];
+  const schema: SchemaLike =
+    nested.length > 0
+      ? {
+          properties: Object.fromEntries(
+            nested.map((child) => [child.name, fieldSchema(child)])
+          ),
+          type: "object",
+        }
+      : { type: PRIMITIVES.has(type) ? type : "string" };
+  const required = nested
+    .filter((child) => child.required)
+    .map((child) => child.name);
+  if (required.length > 0) {
+    schema.required = required;
+  }
+  if (field.default !== undefined) {
+    schema.default = field.default;
+  }
+  if (field.placeholder) {
+    schema.example = field.placeholder;
+  }
+  if (field.deprecated) {
+    schema.deprecated = true;
+  }
+  return schema;
+};
+
+/** The path, query, and header fields as OpenAPI parameters. */
+export const endpointParameters = (fields: EndpointField[]): ParameterLike[] =>
+  fields.flatMap((field) =>
+    field.location === "body"
+      ? []
+      : [
+          {
+            deprecated: field.deprecated === true,
+            in: field.location,
+            name: field.name,
+            // A path parameter is always required.
+            required: field.location === "path" || field.required === true,
+            schema: fieldSchema(field),
+          },
+        ]
+  );
+
+/** The body fields as a JSON request body, or `undefined` when there are none. */
+export const endpointBody = (fields: EndpointField[]) => {
+  const body = fields.filter((field) => field.location === "body");
+  return body.length > 0
+    ? {
+        content: {
+          "application/json": {
+            schema: fieldSchema({
+              fields: body,
+              location: "body",
+              name: "",
+              type: "object",
+            }),
+          },
+        },
+      }
+    : undefined;
+};
+
+/**
+ * The security an endpoint enforces: its page's `authMethod`, else the
+ * site's `api.auth`, else none. An API key goes in the configured header,
+ * `x-api-key` when none is named.
+ */
+export const endpointSecurity = (
+  authMethod?: AuthMethod,
+  siteAuth?: EndpointAuth
+): OperationSecurity => {
+  const method = authMethod ?? siteAuth?.method ?? "none";
+  if (method === "none") {
+    return { alternatives: [], optional: false };
+  }
+  if (method === "key") {
+    return resolveSecurity([{ apiKey: [] }], {
+      apiKey: {
+        in: "header",
+        name: siteAuth?.name ?? "x-api-key",
+        type: "apiKey",
+      },
+    });
+  }
+  return resolveSecurity([{ [method]: [] }], {
+    [method]: { scheme: method, type: "http" },
+  });
+};
+
+/**
+ * The endpoint spec the page's plugin wrote into the `spec` attribute of
+ * `<ApiEndpoint>` and `<ApiPlayground>`.
+ */
+export const readEndpointSpec = (json: string): EndpointSpec =>
+  // SAFETY: the attribute is `JSON.stringify` of an `EndpointSpec`, written
+  // by `markdown/api-rail.ts` at build; authors never write it.
+  JSON.parse(json) as EndpointSpec;

package/src/components/content/badge-color.ts

@@ -1,6 +1,9 @@
-/** The named color each documented Badge `variant` paints with. */
+/**
+ * The named color each documented Badge `variant` paints with; `accent` is
+ * the site's theme accent rather than a fixed hue.
+ */
 const VARIANT_COLOR = new Map([
-  ["accent", "blue"],
+  ["accent", "accent"],
   ["danger", "red"],
   ["default", "gray"],
   ["success", "green"],

package/src/components/content/base-href.ts

@@ -1,48 +1,25 @@
 import data from "blume:data";
 
 import {
-  isInternalPath,
   normalizeBasePath,
-  withBasePath,
-  withComposedBasePath,
+  withAuthoredBasePath,
 } from "../../core/base-path.ts";
 import { routeSetFor, servesRoute } from "../../core/locale-links.ts";
 
-// Mirrors `markdown/base-links.ts`: a path whose final segment carries a file
-// extension is a `public/` asset, served at the site root and never moved
-// under `basePath` — unless a page is served there (a dotted route like
-// `/releases/v1.2`).
-const DOTTED_PATH = /\.[a-z0-9]+$/iu;
-
-/** Strip any `#fragment`/`?query` so only the path is extension-tested. */
-const pathOf = (url: string): string => url.replace(/[#?].*$/u, "");
-
-/** Whether an internal `href` links a page rather than a public asset. */
-const isPageHref = (href: string): boolean => {
-  const path = pathOf(href);
-  return (
-    !DOTTED_PATH.test(path) ||
-    servesRoute(
-      routeSetFor(data.routes),
-      withBasePath(data.config.basePath, path)
-    )
-  );
-};
-
 /**
  * Rebase a component-emitted `href` the way `markdown/base-links.ts` rebases
  * `[x](/guide)`: a root-relative internal page link gains the composed
- * `deployment.base` + `basePath` prefix, so authors write component links
- * (`<Card href="/guide">`) under the same "as if mounted at root" contract as
- * markdown links. Idempotent per layer (a hand-written `/docs/x` isn't
- * double-prefixed) and inert for external URLs, fragments, relative paths, and
- * asset links.
+ * `deployment.base` + `basePath` prefix, and a public asset (`/spec.pdf`, with
+ * no page served there) the deployment base alone, so authors write component
+ * links (`<Card href="/guide">`) under the same "as if mounted at root"
+ * contract as markdown links (see `withAuthoredBasePath`). Idempotent per
+ * layer (a hand-written `/docs/x` isn't double-prefixed) and inert for
+ * external URLs, fragments, and relative paths.
  */
 export const contentHref = (href: string): string =>
-  isInternalPath(href) && isPageHref(href)
-    ? withComposedBasePath(
-        normalizeBasePath(import.meta.env.BASE_URL),
-        data.config.basePath,
-        href
-      )
-    : href;
+  withAuthoredBasePath(
+    normalizeBasePath(import.meta.env.BASE_URL),
+    data.config.basePath,
+    href,
+    (route) => servesRoute(routeSetFor(data.routes), route)
+  );

package/src/components/content/view-switcher.ts

@@ -0,0 +1,71 @@
+/**
+ * The page view picker's logic (see `ViewSwitcher.astro`). A page written in
+ * `<View title>` blocks shows one view at a time. The choice sits on
+ * `<body data-blume-view>`, which each page brings fresh, and a per-page style
+ * hides everything tagged with another view: the `<View>` blocks, the
+ * picker's icons, and the table of contents entries for their headings.
+ */
+
+/**
+ * Where a reader's last-picked view is remembered, across pages. The init
+ * script below spells it out, as it does {@link VIEW_PARAM}.
+ */
+export const VIEW_STORAGE_KEY = "blume-view";
+
+/** The query parameter a shared link picks a view with (`?view=Python`). */
+export const VIEW_PARAM = "view";
+
+/**
+ * The view to show: the first of the candidates the page has, most specific
+ * first (a linked heading's view, the link's `?view=`, the reader's last
+ * pick), else the page's first view.
+ */
+export const chooseView = (
+  titles: readonly string[],
+  candidates: readonly (string | null | undefined)[]
+): string | undefined =>
+  candidates.find(
+    (candidate): candidate is string =>
+      candidate !== null &&
+      candidate !== undefined &&
+      titles.includes(candidate)
+  ) ?? titles[0];
+
+/**
+ * A CSS string for `value`, safe inside a `<style>` element: quotes and
+ * backslashes escaped, `<` as a hex escape so the text can't close the
+ * element, and line breaks (which a CSS string can't hold) as spaces.
+ */
+const cssString = (value: string): string =>
+  `"${value
+    .replaceAll(/["\\]/gu, String.raw`\$&`)
+    .replaceAll("<", String.raw`\3c `)
+    .replaceAll(/[\n\r\f]/gu, " ")}"`;
+
+/**
+ * The page's view CSS: with a view chosen on `<body>`, everything tagged with
+ * another is hidden; before a choice, everything but the first view is.
+ */
+export const viewStyle = (titles: readonly string[]): string => {
+  const [first] = titles;
+  if (first === undefined) {
+    return "";
+  }
+  const other = (title: string): string =>
+    `[data-blume-view]:not([data-blume-view=${cssString(title)}])`;
+  const selectors = [
+    `body:not([data-blume-view]) ${other(first)}`,
+    ...titles.map(
+      (title) => `body[data-blume-view=${cssString(title)}] ${other(title)}`
+    ),
+  ];
+  return `${selectors.join(",")}{display:none!important}`;
+};
+
+/**
+ * Runs inline as the picker is parsed, ahead of the views it controls, so a
+ * link's `?view=` or the reader's last pick applies before anything paints.
+ * Inline scripts run once per session under the client router; after that
+ * the picker element applies the choice as each page swaps in.
+ */
+export const VIEW_INIT_SCRIPT = `(()=>{const s=document.currentScript;const p=s&&s.closest("blume-view-switcher");if(!p)return;let t=[];try{t=JSON.parse(p.getAttribute("data-views")||"[]")}catch{}let r=null;try{r=localStorage.getItem("blume-view")}catch{}const l=new URLSearchParams(location.search).get("view");const v=[l,r].find((c)=>c&&t.includes(c))||t[0];if(!v)return;document.body.setAttribute("data-blume-view",v);const e=p.querySelector("select");if(e)e.value=v;})();`;

package/src/components/index.ts

@@ -25,7 +25,9 @@ export type {
   FrameProps,
   IconProps,
   PanelProps,
+  ParamFieldProps,
   PromptProps,
+  ResponseFieldProps,
   StepProps,
   StepsProps,
   TabProps,

package/src/components/islands/Assistant.astro

@@ -1,4 +1,5 @@
 ---
+import type { CaptchaSettings } from "../../captcha/schema.ts";
 import type { UIStrings } from "../../core/i18n-ui.ts";
 import { resolveIcon } from "../../theme/icons.ts";
 import Assistant from "./assistant.tsx";
@@ -9,12 +10,17 @@ interface Suggestion {
 }
 
 interface Props {
+  /** The bot check's public settings (`ai.assistant.captcha`). */
+  captcha?: CaptchaSettings;
   endpoint?: string;
   strings?: UIStrings["assistant"];
   suggestions?: Suggestion[];
+  /** The Contact support link (`ai.assistant.support`). */
+  support?: string;
 }
 
-const { endpoint, strings, suggestions = [] } = Astro.props;
+const { captcha, endpoint, strings, suggestions = [], support } =
+  Astro.props;
 
 // Icons resolve to inline SVG here (server-only module), so the client island
 // gets ready-to-render markup rather than a name it can't resolve. Bare Lucide
@@ -41,6 +47,7 @@ const icons = {
   clear: bodyFor("trash-2"),
   close: bodyFor("chevrons-right"),
   copy: bodyFor("copy"),
+  remove: bodyFor("x"),
 };
 ---
 
@@ -50,11 +57,13 @@ const icons = {
     panel and re-stamps the body push attribute itself on astro:after-swap
     (see assistant.tsx), since the swap replaces <body> wholesale. */}
 <Assistant
+  captcha={captcha}
   client:load
   endpoint={endpoint}
   icons={icons}
   strings={strings}
   suggestions={items}
+  support={support}
   transition:persist="blume-assistant"
 />