blume 2.0.3 → 2.1.0

package/src/components/content/RequestExample.astro

@@ -0,0 +1,17 @@
+---
+// `<RequestExample>`: code blocks showing a request, one tab per titled
+// fence (or a language menu with `dropdown`). On a wide screen it pins to the
+// column beside the page (see `ApiRail.astro`), above any `<ResponseExample>`.
+import CodeGroup from "./CodeGroup.astro";
+
+interface Props {
+  /** A language menu in place of tabs. */
+  dropdown?: boolean;
+}
+
+const { dropdown = false } = Astro.props;
+---
+
+<CodeGroup dropdown={dropdown}>
+  <slot />
+</CodeGroup>

package/src/components/content/ResponseExample.astro

@@ -0,0 +1,17 @@
+---
+// `<ResponseExample>`: code blocks showing a response, one tab per titled
+// fence (or a language menu with `dropdown`). On a wide screen it pins to the
+// column beside the page (see `ApiRail.astro`), below any `<RequestExample>`.
+import CodeGroup from "./CodeGroup.astro";
+
+interface Props {
+  /** A language menu in place of tabs. */
+  dropdown?: boolean;
+}
+
+const { dropdown = false } = Astro.props;
+---
+
+<CodeGroup dropdown={dropdown}>
+  <slot />
+</CodeGroup>

package/src/components/content/ResponseField.astro

@@ -0,0 +1,32 @@
+---
+// `<ResponseField name="id" type="string" required>`: a field of the
+// response, with optional `pre` and `post` labels around its name and its
+// description in the slot.
+import ApiField from "./ApiField.astro";
+import { fieldLabels } from "./api-field.ts";
+import type { ResponseFieldProps } from "./api-field.ts";
+
+type Props = ResponseFieldProps;
+
+const {
+  default: value,
+  deprecated,
+  name,
+  post,
+  pre,
+  required,
+  type,
+} = Astro.props;
+---
+
+<ApiField
+  default={value}
+  deprecated={deprecated}
+  name={name}
+  post={fieldLabels(post)}
+  pre={fieldLabels(pre)}
+  required={required}
+  type={type}
+>
+  <slot />
+</ApiField>

package/src/components/content/Step.astro

@@ -17,6 +17,7 @@ const canRenderIcon =
 
 <div
   class="relative [counter-increment:blume-step]"
+  data-blume-step
 >
   <span class:list={[markerClass, !canRenderIcon && "before:[content:counter(blume-step)]"]}>
     {canRenderIcon && <Icon name={icon} size={14} />}

package/src/components/content/Tile.astro

@@ -17,6 +17,7 @@ const previewPattern =
 >
   <div
     class="flex aspect-[16/9] min-h-32 items-center justify-center bg-muted/40 p-4 text-muted-foreground [&_img]:max-h-full [&_img]:max-w-full [&_svg]:max-h-full [&_svg]:max-w-full"
+    data-blume-narration="skip"
     data-blume-tile-preview
     style={previewPattern}
   >

package/src/components/content/Tooltip.astro

@@ -39,6 +39,7 @@ const tooltipId = tooltipIdFor(Astro.locals, [
   />
   <span
     class="absolute bottom-full left-1/2 z-20 mb-2 w-max max-w-[min(20rem,calc(100vw-1rem))] -translate-x-1/2 rounded-blume border border-border bg-background p-3 text-start font-sans text-foreground text-sm shadow-lg"
+    data-blume-narration="skip"
     data-blume-tooltip-panel
     id={tooltipId}
     role="tooltip"

package/src/components/content/Tree.astro

@@ -3,6 +3,7 @@
 
 <blume-tree
   class="not-prose my-6 block rounded-blume border border-border bg-background p-3 text-sm"
+  data-blume-narration="skip"
   data-blume-tree
   role="tree"
 >

package/src/components/content/TypeTable.astro

@@ -37,7 +37,10 @@ const columns = "grid grid-cols-[1fr_2fr_auto] items-center gap-4";
 
 {
   entries.length > 0 && (
-    <div class="not-prose my-6 rounded-blume border border-border bg-muted/30 p-1.5">
+    <div
+      class="not-prose my-6 rounded-blume border border-border bg-muted/30 p-1.5"
+      data-blume-narration="skip"
+    >
       <div class={`${columns} px-3 py-2 font-medium text-muted-foreground text-xs`}>
         <span>{strings.prop}</span>
         <span>{strings.type}</span>

package/src/components/content/View.astro

@@ -0,0 +1,21 @@
+---
+/**
+ * One view of a page written for several (`<View title="Python">`), as
+ * Mintlify writes them. Each distinct title is an option of the page's view
+ * picker, and blocks sharing a title show and hide together, so a page can
+ * alternate between prose everyone reads and view-specific sections. The
+ * picker and the hiding live in `ViewSwitcher.astro`; `icon` shows beside
+ * the view's name there.
+ */
+interface Props {
+  class?: string;
+  icon?: string;
+  title: string;
+}
+
+const { class: className, title } = Astro.props;
+---
+
+<div class={className} data-blume-view={title}>
+  <slot />
+</div>

package/src/components/content/ViewSwitcher.astro

@@ -0,0 +1,168 @@
+---
+import type { PageView } from "../../markdown/views.ts";
+import Icon from "../Icon.astro";
+import { VIEW_INIT_SCRIPT, viewStyle } from "./view-switcher.ts";
+
+/**
+ * The picker for a page written in `<View>` blocks, rendered above the
+ * content with the page's views (collected by `markdown/views.ts`). The
+ * style hides every other view's blocks and table of contents entries, and
+ * the inline script applies a linked or remembered choice before the views
+ * paint (see `view-switcher.ts`).
+ */
+interface Props {
+  /** The select's accessible name (`content.selectView`). */
+  label: string;
+  views: PageView[];
+}
+
+const { label, views } = Astro.props;
+const titles = views.map((view) => view.title);
+---
+
+<blume-view-switcher
+  class="not-prose mt-4 mb-8 flex items-center gap-2"
+  data-views={JSON.stringify(titles)}
+>
+  <style is:inline set:html={viewStyle(titles)} />
+  {
+    views.map(
+      (view) =>
+        view.icon && (
+          <span
+            class="inline-flex shrink-0 text-muted-foreground"
+            data-blume-view={view.title}
+          >
+            <Icon name={view.icon} size={16} />
+          </span>
+        )
+    )
+  }
+  <select
+    aria-label={label}
+    class="cursor-pointer rounded-blume border border-border bg-background px-3 py-1.5 font-medium text-foreground text-sm"
+  >
+    {views.map((view) => <option value={view.title}>{view.title}</option>)}
+  </select>
+  <script is:inline set:html={VIEW_INIT_SCRIPT} />
+</blume-view-switcher>
+
+<script>
+  import {
+    chooseView,
+    VIEW_PARAM,
+    VIEW_STORAGE_KEY,
+  } from "./view-switcher.ts";
+
+  const HEADINGS = "h2[id], h3[id], h4[id], h5[id], h6[id]";
+
+  const stored = (): string | null => {
+    try {
+      return localStorage.getItem(VIEW_STORAGE_KEY);
+    } catch {
+      return null;
+    }
+  };
+
+  /** The view holding the element a `#hash` link points at, if any. */
+  const linkedView = (): string | undefined => {
+    const id = decodeURIComponent(location.hash.slice(1));
+    const target = id ? document.getElementById(id) : null;
+    return (
+      target?.closest<HTMLElement>("article [data-blume-view]")?.dataset
+        .blumeView ?? undefined
+    );
+  };
+
+  /**
+   * Tag each table of contents entry with the view its heading is in, so the
+   * page's view style hides it with the view.
+   */
+  const tagTableOfContents = () => {
+    const views = new Map<string, string>();
+    for (const view of document.querySelectorAll<HTMLElement>(
+      "article [data-blume-view]"
+    )) {
+      for (const heading of view.querySelectorAll(HEADINGS)) {
+        views.set(heading.id, view.dataset.blumeView ?? "");
+      }
+    }
+    for (const link of document.querySelectorAll<HTMLAnchorElement>(
+      'blume-toc a[href^="#"]'
+    )) {
+      const id = decodeURIComponent(link.getAttribute("href")?.slice(1) ?? "");
+      const item = link.closest("li");
+      const title = views.get(id);
+      if (item && title) {
+        item.dataset.blumeView = title;
+      }
+    }
+  };
+
+  class BlumeViewSwitcher extends HTMLElement {
+    #titles: string[] = [];
+
+    connectedCallback() {
+      try {
+        this.#titles = JSON.parse(this.dataset.views ?? "[]");
+      } catch {
+        this.#titles = [];
+      }
+      tagTableOfContents();
+      this.#show(
+        chooseView(this.#titles, [
+          linkedView(),
+          new URL(location.href).searchParams.get(VIEW_PARAM),
+          stored(),
+        ])
+      );
+      this.querySelector("select")?.addEventListener("change", this.#onPick);
+      window.addEventListener("hashchange", this.#onHash);
+    }
+
+    disconnectedCallback() {
+      this.querySelector("select")?.removeEventListener("change", this.#onPick);
+      window.removeEventListener("hashchange", this.#onHash);
+    }
+
+    #show(title: string | undefined) {
+      if (title === undefined) {
+        return;
+      }
+      document.body.dataset.blumeView = title;
+      const select = this.querySelector("select");
+      if (select) {
+        select.value = title;
+      }
+    }
+
+    #onPick = (event: Event) => {
+      // SAFETY: the listener is only added to this picker's <select>.
+      const { value } = event.currentTarget as HTMLSelectElement;
+      this.#show(value);
+      try {
+        localStorage.setItem(VIEW_STORAGE_KEY, value);
+      } catch {
+        // Storage can be off; the choice still holds for this page.
+      }
+      // replaceState: the link stays shareable without a history entry per
+      // pick, and the client router needs the entry's state kept.
+      const url = new URL(location.href);
+      url.searchParams.set(VIEW_PARAM, value);
+      history.replaceState(history.state, "", url);
+    };
+
+    // An in-page link to a heading in another view switches to that view.
+    #onHash = () => {
+      const view = linkedView();
+      if (view && view !== document.body.dataset.blumeView) {
+        this.#show(view);
+        document.getElementById(decodeURIComponent(location.hash.slice(1)))?.scrollIntoView();
+      }
+    };
+  }
+
+  if (!customElements.get("blume-view-switcher")) {
+    customElements.define("blume-view-switcher", BlumeViewSwitcher);
+  }
+</script>

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

@@ -0,0 +1,100 @@
+/**
+ * The props `<ParamField>` and `<ResponseField>` take, in Mintlify's shape: a
+ * parameter names its location with the attribute that carries its name
+ * (`<ParamField query="limit">`), and both take `type`, `required`,
+ * `deprecated`, and `default`; a response field adds `pre` and `post` labels
+ * around its name. Pure, so the Markdown downlevel and the playground can
+ * read fields the way the components render them.
+ */
+
+/** Where a `<ParamField>` parameter goes, in the order the attributes are checked. */
+export const PARAM_LOCATIONS = ["path", "query", "header", "body"] as const;
+
+/** A parameter's location. */
+export type ParamLocation = (typeof PARAM_LOCATIONS)[number];
+
+/** A literal value as MDX passes it: a string attribute, or an expression's data. */
+export type FieldValue =
+  | string
+  | number
+  | boolean
+  | null
+  | undefined
+  | FieldValue[]
+  | { [key: string]: FieldValue };
+
+/** A boolean prop: MDX shorthand (`required`) is `true`, `required="true"` a string. */
+export type FlagProp = boolean | string;
+
+/** What both field components take. */
+export interface FieldProps {
+  /** The value used when none is given. */
+  default?: FieldValue;
+  deprecated?: FlagProp;
+  required?: FlagProp;
+  /** Free text: `string`, `integer`, `string[]`, `object`. */
+  type?: string;
+}
+
+/** `<ParamField>`: a request parameter, named by its location attribute. */
+export interface ParamFieldProps extends FieldProps {
+  body?: string;
+  header?: string;
+  /** The name, for a field with no location attribute. */
+  name?: string;
+  path?: string;
+  /** Placeholder text for the parameter's playground input. */
+  placeholder?: string;
+  query?: string;
+}
+
+/** `<ResponseField>`: a field of the response. */
+export interface ResponseFieldProps extends FieldProps {
+  name: string;
+  /** Labels after the name. */
+  post?: string | string[];
+  /** Labels before the name. */
+  pre?: string | string[];
+}
+
+/** Whether a flag prop is on. */
+export const isOn = (value?: FlagProp): boolean =>
+  value === true || value === "true";
+
+/** Where a parameter goes, and what it's called. */
+export interface ParamFieldName {
+  location?: ParamLocation;
+  name?: string;
+}
+
+/** A parameter's location and name: the first location attribute set, else `name`. */
+export const paramField = (props: ParamFieldProps): ParamFieldName => {
+  for (const location of PARAM_LOCATIONS) {
+    const name = props[location];
+    if (name !== undefined) {
+      return { location, name };
+    }
+  }
+  return { name: props.name };
+};
+
+const isText = (value: FieldValue): value is string =>
+  typeof value === "string";
+
+/** A default value as shown: text as written, anything else as JSON; `null` when there is none. */
+export const defaultLabel = (value?: FieldValue): string | null => {
+  if (value === undefined || value === null || value === "") {
+    return null;
+  }
+  return isText(value) ? value : JSON.stringify(value);
+};
+
+/** `pre`/`post` labels as a list, whether one was written or several. */
+export const fieldLabels = (value?: string | string[]): string[] => {
+  if (value === undefined) {
+    return [];
+  }
+  return (Array.isArray(value) ? value : [value]).filter(
+    (label) => label !== ""
+  );
+};

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;