blume 2.0.3 → 2.1.1

package/src/cli/required-secrets.ts

@@ -2,12 +2,66 @@ import { resolveAskBackend } from "../ai/ask.ts";
 import type { ResolvedConfig } from "../core/schema.ts";
 import type { Diagnostic } from "../core/types.ts";
 
+/** A feature, and the secrets the adapter behind it reads. */
+interface SecretOwner {
+  feature: string;
+  note?: string;
+  secrets: string[];
+}
+
+/**
+ * The adapters that name their own secrets. The built-ins mostly declare
+ * none: analytics ships public tokens in the page, consent managers load
+ * public scripts, reference adapters read public specs, and host adapters
+ * read platform-injected env.
+ */
+const adapterSecretOwners = (config: ResolvedConfig): SecretOwner[] => {
+  const { consent, deployment, rateLimit } = config;
+  const { provider } = config.search;
+  const owners: SecretOwner[] = [
+    // Each search adapter declares the secrets its generated runtime reads.
+    { feature: `Search (${provider.kind})`, secrets: provider.requiredSecrets },
+    ...config.analytics.map((adapter) => ({
+      feature: `Analytics (${adapter.kind})`,
+      secrets: adapter.requiredSecrets,
+    })),
+    // Each content source adapter declares the env vars its fetch reads.
+    ...config.content.sources.map((source) => ({
+      feature: `Content source (${source.kind})`,
+      secrets: source.requiredSecrets,
+    })),
+    ...config.reference.map((adapter) => ({
+      feature: `API reference (${adapter.kind})`,
+      secrets: adapter.requiredSecrets,
+    })),
+    {
+      feature: `Deployment (${deployment.kind})`,
+      secrets: deployment.requiredSecrets,
+    },
+  ];
+  if (consent) {
+    owners.push({
+      feature: `Consent (${consent.kind})`,
+      secrets: consent.requiredSecrets,
+    });
+  }
+  // Upstash's endpoint and token.
+  if (rateLimit) {
+    owners.push({
+      feature: `Rate limiting (${rateLimit.kind})`,
+      note: "read at request time; without it the routes count in memory",
+      secrets: rateLimit.requiredSecrets,
+    });
+  }
+  return owners;
+};
+
 /**
  * Warn early when an enabled feature needs a secret env var that isn't set, so
  * the failure surfaces at `blume dev`/`build` instead of at the first request in
  * production. These are runtime secrets (the endpoint reads them on the server),
  * so this warns rather than hard-fails — the value may live only in the deploy
- * environment. Build-time secrets (search-index sync) already warn during sync.
+ * environment. Build-time secrets (search-index sync) are checked by the sync.
  */
 export const checkRequiredSecrets = (config: ResolvedConfig): Diagnostic[] => {
   const diagnostics: Diagnostic[] = [];
@@ -26,47 +80,35 @@ export const checkRequiredSecrets = (config: ResolvedConfig): Diagnostic[] => {
 
   if (config.ai.assistant?.enabled && !config.ai.assistant.endpoint) {
     // The adapter descriptor names the env vars its route reads.
-    const { provider } = config.ai.assistant;
+    const { captcha, provider } = config.ai.assistant;
     const backend = resolveAskBackend(provider);
     for (const env of provider.requiredSecrets) {
       requireSecret(`Assistant (${backend.label})`, env, backend.secretNote);
     }
-  }
-
-  // Each search adapter declares the secrets its generated runtime reads.
-  const { provider } = config.search;
-  for (const env of provider.requiredSecrets) {
-    requireSecret(`Search (${provider.kind})`, env);
-  }
-
-  // Adapters name their own secrets; the built-in analytics adapters ship
-  // public tokens in the page and declare none.
-  for (const adapter of config.analytics) {
-    for (const env of adapter.requiredSecrets) {
-      requireSecret(`Analytics (${adapter.kind})`, env);
+    // The bot check's secret key, which the route verifies tokens with.
+    for (const env of captcha?.requiredSecrets ?? []) {
+      requireSecret(`Assistant bot check (${captcha?.kind})`, env);
     }
   }
 
-  // Each content source adapter declares the env vars its fetch reads.
-  for (const source of config.content.sources) {
-    for (const env of source.requiredSecrets) {
-      requireSecret(`Content source (${source.kind})`, env);
+  // Generated narration reads its key at build, not at runtime; without it the
+  // build skips the audio and pages read with browser voices.
+  const { narration } = config;
+  if (narration.enabled && narration.provider) {
+    for (const env of narration.provider.requiredSecrets) {
+      requireSecret(
+        "Narration audio",
+        env,
+        "read at build; without it pages use browser voices"
+      );
     }
   }
 
-  // Adapters name their own secrets; the built-in reference adapters read
-  // public specs and declare none.
-  for (const adapter of config.reference) {
-    for (const env of adapter.requiredSecrets) {
-      requireSecret(`API reference (${adapter.kind})`, env);
+  for (const owner of adapterSecretOwners(config)) {
+    for (const env of owner.secrets) {
+      requireSecret(owner.feature, env, owner.note);
     }
   }
 
-  // The deployment adapter names its own secrets; the built-in host adapters
-  // read platform-injected env and declare none.
-  for (const env of config.deployment.requiredSecrets) {
-    requireSecret(`Deployment (${config.deployment.kind})`, env);
-  }
-
   return diagnostics;
 };

package/src/components/BlumePage.astro

@@ -49,6 +49,7 @@ import TreeRoot from "./content/Tree.astro";
 import TreeFile from "./content/TreeFile.astro";
 import TreeFolder from "./content/TreeFolder.astro";
 import TypeTable from "./content/TypeTable.astro";
+import View from "./content/View.astro";
 import Visibility from "./content/Visibility.astro";
 import YouTube from "./content/YouTube.astro";
 
@@ -96,6 +97,7 @@ const components = {
   Tooltip,
   Tree,
   TypeTable,
+  View,
   Visibility,
   YouTube,
   ...extra,

package/src/components/content/ApiEndpoint.astro

@@ -0,0 +1,18 @@
+---
+// The method and path at the top of a page with `api` frontmatter, as an
+// OpenAPI operation page shows them. `markdown/api-rail.ts` places it.
+import MethodBadge from "../openapi/MethodBadge.astro";
+import { readEndpointSpec } from "./api-page.ts";
+
+interface Props {
+  /** The endpoint, as the page's plugin wrote it. */
+  spec: string;
+}
+
+const { method, target } = readEndpointSpec(Astro.props.spec);
+---
+
+<div class="not-prose mb-6 flex flex-wrap items-center gap-3">
+  <MethodBadge method={method} />
+  <code class="break-all font-mono text-foreground text-sm">{target}</code>
+</div>

package/src/components/content/ApiField.astro

@@ -0,0 +1,79 @@
+---
+// The row behind `<ParamField>` and `<ResponseField>`: the name with its
+// labels, location, type, and flags, the default, then the description from
+// the slot, which may hold any MDX, nested fields in an `<Expandable>`
+// included. Styled like the OpenAPI reference's rows, so a hand-written API
+// page reads like a generated one. Narration skips it, as it does type tables.
+import { defaultLabel, isOn } from "./api-field.ts";
+import type { FieldValue, FlagProp } from "./api-field.ts";
+
+interface Props {
+  default?: FieldValue;
+  deprecated?: FlagProp;
+  location?: string;
+  name?: string;
+  post?: string[];
+  pre?: string[];
+  required?: FlagProp;
+  type?: string;
+}
+
+const {
+  default: value,
+  deprecated,
+  location,
+  name,
+  post = [],
+  pre = [],
+  required,
+  type,
+} = Astro.props;
+const shownDefault = defaultLabel(value);
+const labelClass =
+  "rounded bg-muted px-1.5 py-0.5 font-medium text-[0.625rem] text-muted-foreground uppercase tracking-wide";
+---
+
+<div
+  class="border-border border-b py-4"
+  data-blume-field
+  data-blume-narration="skip"
+>
+  <div class="not-prose flex flex-wrap items-baseline gap-x-2 gap-y-1">
+    {pre.map((label) => <span class={labelClass}>{label}</span>)}
+    {name && <code class="font-mono text-foreground text-sm">{name}</code>}
+    {post.map((label) => <span class={labelClass}>{label}</span>)}
+    {location && <span class={labelClass}>{location}</span>}
+    {type && <span class="text-muted-foreground text-xs">{type}</span>}
+    {
+      isOn(required) && (
+        <span class="font-medium text-[0.625rem] text-red-600 uppercase tracking-wide dark:text-red-400">
+          required
+        </span>
+      )
+    }
+    {
+      isOn(deprecated) && (
+        <span class="font-medium text-[0.625rem] text-muted-foreground uppercase tracking-wide line-through">
+          deprecated
+        </span>
+      )
+    }
+  </div>
+  {
+    shownDefault !== null && (
+      <div class="not-prose mt-2 text-muted-foreground text-xs">
+        Default:{" "}
+        <code class="rounded bg-muted px-1 py-0.5 text-foreground">
+          {shownDefault}
+        </code>
+      </div>
+    )
+  }
+  {
+    Astro.slots.has("default") && (
+      <div class="mt-2 text-muted-foreground text-sm [&>:first-child]:mt-0 [&>:last-child]:mb-0">
+        <slot />
+      </div>
+    )
+  }
+</div>

package/src/components/content/ApiPlayground.astro

@@ -0,0 +1,66 @@
+---
+// A hand-written endpoint's Try it panel and request samples, at the head of
+// its rail: the page's `<ParamField>`s become the parameters and body of an
+// operation model like a spec'd operation's (see `api-page.ts`), so the
+// playground and the samples are the OpenAPI reference's own. A page's own
+// `<RequestExample>` stands in for the generated samples, and its
+// `playground` frontmatter can drop the Try it panel (`simple`).
+import data from "blume:data";
+
+import { operationModel } from "../openapi/operation-model.ts";
+import Playground from "../openapi/Playground.astro";
+import { buildRequest, defaultValues } from "../openapi/request.ts";
+import RequestPanel from "../openapi/RequestPanel.astro";
+import {
+  DEFAULT_SAMPLE_LANGUAGES,
+  sampleLanguages,
+} from "../openapi/snippets.ts";
+import {
+  endpointBody,
+  endpointParameters,
+  endpointSecurity,
+  endpointTarget,
+  readEndpointSpec,
+} from "./api-page.ts";
+
+interface Props {
+  /** The endpoint, as the page's plugin wrote it. */
+  spec: string;
+}
+
+const spec = readEndpointSpec(Astro.props.spec);
+const { api } = data.config;
+const { path, servers } = endpointTarget(spec.target, api.server);
+const model = operationModel({
+  method: spec.method,
+  parameters: endpointParameters(spec.fields),
+  path,
+  requestBody: endpointBody(spec.fields),
+  schemas: {},
+  security: endpointSecurity(spec.authMethod, api.auth),
+  servers,
+});
+const tryIt = spec.playground !== "simple" && api.playground.enabled;
+---
+
+{
+  tryIt && (
+    <Playground
+      model={model}
+      operation={`${spec.method} ${spec.target}`}
+      proxy={api.playground.proxy}
+      proxyConfig="api"
+      slug="api-pages"
+    />
+  )
+}
+{
+  !spec.requestExample && (
+    <RequestPanel
+      languages={sampleLanguages(DEFAULT_SAMPLE_LANGUAGES)}
+      responses={{}}
+      sample={buildRequest(model, defaultValues(model))}
+      schemas={{}}
+    />
+  )
+}

package/src/components/content/ApiRail.astro

@@ -0,0 +1,19 @@
+---
+// The column `<RequestExample>` and `<ResponseExample>` pin to, which
+// `markdown/api-rail.ts` gathers at the end of the page. At `xl` it sits
+// beside the page's content, which the layout pads to make room, and sticks
+// under the header like an OpenAPI operation's sample panel; below `xl` it
+// follows the content.
+import OperationPanel from "../openapi/OperationPanel.astro";
+---
+
+<div
+  class="not-prose mt-10 xl:absolute xl:inset-y-0 xl:end-0 xl:mt-0 xl:w-[28rem]"
+  data-blume-api-rail
+>
+  <OperationPanel>
+    <div class="flex flex-col gap-4 [&>*]:my-0">
+      <slot />
+    </div>
+  </OperationPanel>
+</div>

package/src/components/content/Color.astro

@@ -10,6 +10,7 @@ const { variant = "compact" } = Astro.props;
       : "grid grid-cols-2 gap-x-5 gap-y-4 sm:grid-cols-4",
   ]}
   data-blume-color={variant}
+  data-blume-narration="skip"
 >
   <slot />
 </div>

package/src/components/content/FileTree.astro

@@ -3,6 +3,7 @@
 
 <div
   class="not-prose my-6 rounded-blume border border-border p-5 text-sm [&_ul]:m-0! [&_ul]:list-none [&_ul]:ps-4 [&>ul]:ps-0"
+  data-blume-narration="skip"
 >
   <slot />
 </div>

package/src/components/content/GithubInfo.astro

@@ -73,6 +73,7 @@ const { content: strings } = contentStrings(data, Astro.currentLocale);
   owner && repo && (
     <a
       class="not-prose my-6 flex flex-col gap-2 rounded-blume border border-border p-4 no-underline! transition-colors hover:border-foreground/30 hover:bg-muted/40"
+      data-blume-narration="skip"
       href={`${host}/${owner}/${repo}`}
       {...NEW_TAB_ATTRS}
     >

package/src/components/content/Panel.astro

@@ -4,6 +4,7 @@ const { title } = Astro.props;
 
 <aside
   class="not-prose my-6 overflow-hidden rounded-blume border border-border/80 bg-background shadow-sm shadow-border/30"
+  data-blume-narration="skip"
   data-blume-panel
   data-blume-right-rail-item
 >

package/src/components/content/ParamField.astro

@@ -0,0 +1,25 @@
+---
+// `<ParamField query="limit" type="integer" required>`: a request parameter,
+// named by the attribute that says where it goes (`path`, `query`, `header`,
+// or `body`), with its description in the slot. On a page with `api`
+// frontmatter the fields also build that page's playground.
+import ApiField from "./ApiField.astro";
+import { paramField } from "./api-field.ts";
+import type { ParamFieldProps } from "./api-field.ts";
+
+type Props = ParamFieldProps;
+
+const { location, name } = paramField(Astro.props);
+const { default: value, deprecated, required, type } = Astro.props;
+---
+
+<ApiField
+  default={value}
+  deprecated={deprecated}
+  location={location}
+  name={name}
+  required={required}
+  type={type}
+>
+  <slot />
+</ApiField>

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>