blume 1.1.1 → 1.1.3

package/dist/types/ai/component-markdown.d.ts

@@ -1,3 +1,4 @@
+import type { ExampleLookup } from "../core/types.ts";
 /** Evaluated props plus whether any attribute resisted static evaluation. */
 interface EvaluatedProps {
     lossy: boolean;
@@ -27,6 +28,15 @@ export interface ComponentMarkdownContext extends EvaluatedProps {
  * fallback when the props can't be recovered statically).
  */
 export type ComponentMarkdown = (context: ComponentMarkdownContext) => string | null;
+/**
+ * Build the `<Component>` serializer for a project's discovered examples. The
+ * live preview can't survive the trip to Markdown, so the agent-facing output
+ * carries the example's source — the same code the "Code" tab shows — as a
+ * fenced block. An unknown `path` (or a missing `path` prop) declines, leaving
+ * the JSX verbatim, mirroring the "no example found" note the component renders
+ * on the page.
+ */
+export declare const exampleComponentSerializers: (examples: ExampleLookup) => Record<string, ComponentMarkdown>;
 /**
  * Downlevel supported components in an MDX source to plain Markdown. Sources
  * with no supported components — and sources Satteri can't parse as MDX, e.g.

package/dist/types/core/config-input.d.ts

@@ -1,4 +1,5 @@
 import type { ComponentMarkdown } from "../ai/component-markdown.ts";
+import type { CodeTheme } from "../markdown/themes.ts";
 import type { FontSlug } from "../theme/fonts.ts";
 import type { OpenApiSource, SearchProvider, SidebarDisplay, SidebarItemConfig } from "./schema.ts";
 import type { ContentSource } from "./sources/types.ts";
@@ -722,12 +723,12 @@ export interface MarkdownConfig {
      * `` `code`{:lang} ``, `<CodeBlock>`, and `<Diff>`.
      */
     codeBlocks?: {
-        /** Shiki theme names per color mode. */
+        /** Bundled Shiki theme names or inline custom Shiki themes per color mode. */
         theme?: {
-            /** Dark-mode theme. Defaults to `github-dark`. */
-            dark?: string;
-            /** Light-mode theme. Defaults to `github-light`. */
-            light?: string;
+            /** Dark-mode theme name or custom theme. Defaults to `github-dark`. */
+            dark?: CodeTheme;
+            /** Light-mode theme name or custom theme. Defaults to `github-light`. */
+            light?: CodeTheme;
         };
     };
     /**
@@ -764,6 +765,13 @@ export interface OpenApiConfig {
     renderer?: "blume" | "scalar";
     /** Where the reference mounts. Defaults to `/reference`. */
     route?: string;
+    /**
+     * Extra Scalar options forwarded verbatim to the embedded `<ScalarComponent>`
+     * (Scalar renderer only) — e.g. `localization`, `agent`,
+     * `hideTestRequestButton`, `orderSchemaPropertiesBy`. These win over Blume's
+     * derived spec/theme config, so it's a full escape hatch to Scalar's API.
+     */
+    scalar?: Record<string, unknown>;
     /** One or more specs; each renders on its own route by default. */
     sources?: OpenApiSource[];
     /** Shorthand for a single source: `sources: [{ spec }]`. */
@@ -781,6 +789,12 @@ export interface AsyncApiConfig {
     enabled?: boolean;
     /** Where the reference mounts. Defaults to `/events`. */
     route?: string;
+    /**
+     * Extra Scalar options forwarded verbatim to the embedded `<ScalarComponent>`.
+     * These win over Blume's derived spec/theme config — a full escape hatch to
+     * Scalar's API.
+     */
+    scalar?: Record<string, unknown>;
     /** One or more specs. */
     sources?: OpenApiSource[];
     /** Shorthand for a single source. */
@@ -856,6 +870,32 @@ export type LastModifiedConfig = boolean | {
     /** Where the date comes from. Defaults to `git`. */
     type?: "git" | "frontmatter";
 };
+/**
+ * Date presentation for the "last updated" stamp and the changelog timeline —
+ * a curated pass-through to `Intl.DateTimeFormat`, shared by both surfaces.
+ * Defaults to `{ dateStyle: "long" }`. Dates render in UTC unless `timeZone` is
+ * set. `dateStyle` is a preset and can't be combined with the component fields.
+ */
+export interface DateFormatConfig {
+    /** Preset date length; mutually exclusive with the component fields below. */
+    dateStyle?: "full" | "long" | "medium" | "short";
+    /** Weekday representation. */
+    weekday?: "long" | "short" | "narrow";
+    /** Era representation (e.g. the Japanese imperial era). */
+    era?: "long" | "short" | "narrow";
+    /** Year representation. */
+    year?: "numeric" | "2-digit";
+    /** Month representation. */
+    month?: "numeric" | "2-digit" | "long" | "short" | "narrow";
+    /** Day representation. */
+    day?: "numeric" | "2-digit";
+    /** IANA time zone (e.g. `Asia/Tokyo`). Defaults to `UTC`. */
+    timeZone?: string;
+    /** Calendar system (e.g. `japanese`, `buddhist`). */
+    calendar?: string;
+    /** Numbering system (e.g. `latn`, `arab`). */
+    numberingSystem?: string;
+}
 /**
  * On-page table of contents. `true`/`false` toggles it; the object form narrows
  * the heading range. Defaults to on, H2–H3.
@@ -892,6 +932,11 @@ export interface BlumeConfig {
     basePath?: string;
     /** Where content lives and how it's discovered. */
     content?: ContentConfig;
+    /**
+     * Date presentation for the "last updated" stamp and the changelog timeline.
+     * Pass-through `Intl.DateTimeFormat` options; defaults to `{ dateStyle: "long" }`.
+     */
+    dateFormat?: DateFormatConfig;
     /** Where and how the site deploys (site URL, adapter, output mode). */
     deployment?: DeploymentConfig;
     /** Default meta description, used where a page sets none. */

package/dist/types/core/i18n-ui.d.ts

@@ -77,9 +77,9 @@ declare const uiStringsObject: z.ZodObject<{
         title: z.ZodDefault<z.ZodString>;
         you: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         label: string;
         ai: string;
+        title: string;
         empty: string;
         error: string;
         placeholder: string;
@@ -90,9 +90,9 @@ declare const uiStringsObject: z.ZodObject<{
         tip: string;
         you: string;
     }, {
-        title?: string | undefined;
         label?: string | undefined;
         ai?: string | undefined;
+        title?: string | undefined;
         empty?: string | undefined;
         error?: string | undefined;
         placeholder?: string | undefined;
@@ -115,12 +115,12 @@ declare const uiStringsObject: z.ZodObject<{
         showReleases: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         description: string;
+        title: string;
         showReleases: string;
     }, {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         showReleases?: string | undefined;
     }>>;
     content: z.ZodDefault<z.ZodObject<{
@@ -198,12 +198,12 @@ declare const uiStringsObject: z.ZodObject<{
         home: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         description: string;
+        title: string;
         home: string;
     }, {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         home?: string | undefined;
     }>>;
     page: z.ZodDefault<z.ZodObject<{
@@ -283,9 +283,9 @@ declare const uiStringsObject: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     ask: {
-        title: string;
         label: string;
         ai: string;
+        title: string;
         empty: string;
         error: string;
         placeholder: string;
@@ -333,8 +333,8 @@ declare const uiStringsObject: z.ZodObject<{
         results: string;
     };
     changelog: {
-        title: string;
         description: string;
+        title: string;
         showReleases: string;
     };
     toc: {
@@ -377,15 +377,15 @@ declare const uiStringsObject: z.ZodObject<{
         toggleTheme: string;
     };
     notFound: {
-        title: string;
         description: string;
+        title: string;
         home: string;
     };
 }, {
     ask?: {
-        title?: string | undefined;
         label?: string | undefined;
         ai?: string | undefined;
+        title?: string | undefined;
         empty?: string | undefined;
         error?: string | undefined;
         placeholder?: string | undefined;
@@ -433,8 +433,8 @@ declare const uiStringsObject: z.ZodObject<{
         results?: string | undefined;
     } | undefined;
     changelog?: {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         showReleases?: string | undefined;
     } | undefined;
     toc?: {
@@ -477,8 +477,8 @@ declare const uiStringsObject: z.ZodObject<{
         toggleTheme?: string | undefined;
     } | undefined;
     notFound?: {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         home?: string | undefined;
     } | undefined;
 }>;
@@ -552,9 +552,9 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         title: z.ZodDefault<z.ZodString>;
         you: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         label: string;
         ai: string;
+        title: string;
         empty: string;
         error: string;
         placeholder: string;
@@ -565,9 +565,9 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         tip: string;
         you: string;
     }, {
-        title?: string | undefined;
         label?: string | undefined;
         ai?: string | undefined;
+        title?: string | undefined;
         empty?: string | undefined;
         error?: string | undefined;
         placeholder?: string | undefined;
@@ -590,12 +590,12 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         showReleases: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         description: string;
+        title: string;
         showReleases: string;
     }, {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         showReleases?: string | undefined;
     }>>;
     content: z.ZodDefault<z.ZodObject<{
@@ -673,12 +673,12 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         home: z.ZodDefault<z.ZodString>;
         title: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        title: string;
         description: string;
+        title: string;
         home: string;
     }, {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         home?: string | undefined;
     }>>;
     page: z.ZodDefault<z.ZodObject<{
@@ -758,9 +758,9 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     ask: {
-        title: string;
         label: string;
         ai: string;
+        title: string;
         empty: string;
         error: string;
         placeholder: string;
@@ -808,8 +808,8 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         results: string;
     };
     changelog: {
-        title: string;
         description: string;
+        title: string;
         showReleases: string;
     };
     toc: {
@@ -852,15 +852,15 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         toggleTheme: string;
     };
     notFound: {
-        title: string;
         description: string;
+        title: string;
         home: string;
     };
 }, {
     ask?: {
-        title?: string | undefined;
         label?: string | undefined;
         ai?: string | undefined;
+        title?: string | undefined;
         empty?: string | undefined;
         error?: string | undefined;
         placeholder?: string | undefined;
@@ -908,8 +908,8 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         results?: string | undefined;
     } | undefined;
     changelog?: {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         showReleases?: string | undefined;
     } | undefined;
     toc?: {
@@ -952,8 +952,8 @@ export declare const uiStringsSchema: z.ZodDefault<z.ZodObject<{
         toggleTheme?: string | undefined;
     } | undefined;
     notFound?: {
-        title?: string | undefined;
         description?: string | undefined;
+        title?: string | undefined;
         home?: string | undefined;
     } | undefined;
 }>>;