@ascribed/astro 0.2.1-next.15 → 0.2.1-next.17

package/README.md

@@ -16,13 +16,13 @@ import { defineConfig } from "astro/config";
 import ascribe from "@ascribed/astro";
 
 export default defineConfig({
-  site: "https://docs.example.com", // as in ascribe.toml's [consumer]
-  base: "/docs",
-  trailingSlash: "never",
+  // `site`, `base`, and `trailingSlash` come from ascribe.toml's [consumer].
   integrations: [ascribe({ build: "site" })],
 });
 ```
 
+Astro's `site`, `base`, and `trailingSlash` come from `ascribe.toml`'s `[consumer]` when the Astro config leaves them out. With `projects`, `site` and `trailingSlash` come from the first entry whose project sets them, and `base` stays the site's. Set in the Astro config, each must agree with `[consumer]`, or the build fails.
+
 ```ts
 // src/content.config.ts
 import { defineCollection } from "astro:content";
@@ -35,7 +35,7 @@ export const collections = { docs: defineCollection(ascribeCollection({ schema }
 
 If the Ascribe project is outside the Astro root (`project: "../docs"`), import `../.astro/integrations/_ascribed_astro/schema.ts` instead: the integration copies the schema there after each build, so TypeScript finds `astro/zod` from it.
 
-`[consumer] base-path` can be Astro's `base` or a path under it, so a home page can sit at `/` in front of docs at `/docs/`. Several projects can share one site, each under its own base path:
+`[consumer] base-path` can be Astro's `base` or a path under it, so a home page can sit at `/` in front of docs at `/docs/`: list the docs in `projects`, even alone, so Astro's `base` stays `/`. Several projects can share one site, each under its own base path:
 
 ```js
 ascribe({
@@ -52,15 +52,26 @@ ascribe({
 // A layout
 import Elements from "@ascribed/astro/Elements.astro";
 import Availability from "@ascribed/astro/Availability.astro";
+import Head from "@ascribed/astro/Head.astro";
 const { entry } = Astro.props;
 ---
-<head><Elements /></head>
+<head>
+  <!-- Everything the head says about the page, from its record. -->
+  <Head entry={entry} title={(title, record) => `${title} · Loom`} name="Loom" />
+  <Elements />
+</head>
 <Availability available={entry.data.available} />
 <!-- With `inline = "code"` on `title`: its code spans as <code>. -->
 <h1 set:html={entry.data.formatted.title} />
 ```
 
-The [Astro guide](https://ascribed-dev.com/docs/guides/astro/) walks through a site: `ascribe.toml`, the collection, the route, the layout, the options, [a home page in front of the docs](https://ascribed-dev.com/docs/guides/astro/#a-home-page-in-front-of-the-docs), [several projects in one site](https://ascribed-dev.com/docs/guides/astro/#several-projects-in-one-site), what `astro dev` does, and [review in the site preview](https://ascribed-dev.com/docs/guides/astro/#review-in-the-site-preview). [Review](https://ascribed-dev.com/docs/guides/review/) walks through reviewing a pull request on your site.
+Each build writes a record of every page, `_ascribe/pages.json`, and the integration writes from every project's records what search engines read: `Head.astro` gives a page its `<title>`, description, canonical link, `noindex` when it's `unlisted`, and `nosnippet` when it's `unquoted`, a link to its Markdown version, the Open Graph tags a link preview reads, with the site's name and a social card given as properties, and its breadcrumbs as structured data, and `astro dev` warns about a tag a layout writes again; and the site gets one `sitemap.xml`, at Astro's `base`, and one `robots.txt`, at the host's root, with each project's `[crawlers] lines` and a group for each kind of crawler it disallows, such as `training = "disallow"`, in `astro build` and `astro dev`; projects that disagree on a kind fail the build. A page with no record, such as an Astro page of the site's own, gets nothing from `Head.astro` and is in the sitemap as a page Astro built. A site with its own `public/robots.txt` or `public/sitemap.xml` keeps it, and a site whose `base` isn't `/` gets no `robots.txt`: the build prints the lines its host's needs. With no `site`, there's no sitemap.
+
+A page's Markdown version has no head, so its rules are response headers, which each build lists in `_ascribe/headers.json`: `X-Robots-Tag` when the page isn't listed, and a canonical `Link` to the page. `astro dev` sends them. With `[consumer] headers = "netlify"`, `astro build` writes them into the site's `_headers`; a site with its own `public/_headers` keeps it, and the build fails with the lines it lacks.
+
+`npx @ascribed/astro init` writes those files into an Astro project once, as yours from then on: the collection (`src/content.config.ts`), the route (`src/pages/[...slug].astro`), a layout that loads the elements (`src/layouts/Docs.astro`), and the sidebar's list (`src/nav.ts`). It never writes over a file. `--project <dir>` names the folder holding `ascribe.toml`, and `--build <name>` the build, when there are several. The layout's sidebar comes from `sidebar(nav, entries)` in `@ascribed/astro/content`, which gives each listed page its entry and address, and fails the build when the list leaves out a page or names one that isn't there.
+
+The [Astro guide](https://ascribed-dev.com/go/astro-guide/) walks through a site: `ascribe.toml`, the collection, the route, the layout, the options, [a home page in front of the docs](https://ascribed-dev.com/go/a-home-page-in-front-of-the-docs/), [several projects in one site](https://ascribed-dev.com/go/several-projects-in-one-site/), search engines and crawlers, what `astro dev` does, and [review in the site preview](https://ascribed-dev.com/go/review-in-the-site-preview/). [Review](https://ascribed-dev.com/go/review-guide/) walks through reviewing a pull request on your site.
 
 ## Options
 
@@ -73,13 +84,16 @@ The [Astro guide](https://ascribed-dev.com/docs/guides/astro/) walks through a s
 | `anchors` | Source anchors (`ascribe build --anchors`), for review: `"dev"` in `astro dev` only, `true` always. By default, `false`, though `review` turns them on in `astro dev`. |
 | `review` | The **Ascribe review** app in `astro dev`'s toolbar: a pull request's changes and comments on the real page. `false` leaves it out. By default, `true`. Never in `astro build`. With `projects`, an entry's name reviews that entry, and `true` the first. |
 | `codeTitles` | A code block's title (`title="…"` in its info string, as `@snippet` writes it) above it: a Shiki transformer puts the block in a `<figure class="code-title">` with a `<figcaption>`. `false` leaves it out. By default, `true`. |
+| `sitemap` | `{ exclude: [...] }`: routes of the site's own pages, from the host's root, to leave out of the sitemap, such as one that carries `noindex`. |
 
 ## Development
 
 | File | Role |
 |---|---|
 | `src/index.ts` | The integration |
-| `src/content.ts` | `ascribeCollection`, for `content.config.ts` |
+| `src/content.ts` | `ascribeCollection`, for `content.config.ts`, and `sidebar`, for a layout |
+| `src/nav.ts` | The sidebar: entry ids, routes, and the check of the site's list against the collection |
+| `src/init.ts`, `src/cli.ts`, `starter/` | `npx @ascribed/astro init`, the package's command (`ascribe-astro`), and the files it writes. `examples/astro-site`'s are what it writes for that project; `test/init.test.ts` holds that, and rewrites them with `ASCRIBE_BLESS=1` |
 | `src/Elements.astro` | Loads `@ascribed/elements` (stylesheet and script) |
 | `src/Availability.astro` | A page's availability as the element library's badge |
 | `src/code-titles.ts` | The Shiki transformer that shows code block titles |

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+// `npx @ascribed/astro`: the package's command, `ascribe-astro`. Its one
+// subcommand, `init`, writes the starter (src/init.ts).
+import { parseArgs } from "node:util";
+import { init, STARTER_FILES } from "./init.js";
+const USAGE = `Usage: npx @ascribed/astro init [--project <dir>] [--build <name>]
+
+Writes the files every site built with Ascribe starts from into the Astro
+project in the current folder, once: ${STARTER_FILES.join(", ")}.
+It writes nothing if any of them is there.
+
+Options:
+  --project <dir>   The folder holding ascribe.toml, from the current folder. Default: the current folder.
+  --build <name>    The build the site shows. Default: the project's one build.
+  -h, --help        Print this.`;
+function main(argv) {
+    let parsed;
+    try {
+        parsed = parseArgs({
+            args: argv,
+            allowPositionals: true,
+            options: {
+                project: { type: "string" },
+                build: { type: "string" },
+                help: { type: "boolean", short: "h" },
+            },
+        });
+    }
+    catch (error) {
+        process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n\n${USAGE}\n`);
+        return 2;
+    }
+    const { values, positionals } = parsed;
+    if (values.help === true) {
+        process.stdout.write(`${USAGE}\n`);
+        return 0;
+    }
+    if (positionals.length !== 1 || positionals[0] !== "init") {
+        process.stderr.write(`${USAGE}\n`);
+        return 2;
+    }
+    return run(values.project, values.build);
+}
+async function run(project, build) {
+    try {
+        const result = await init({ root: process.cwd(), project, build });
+        const options = [`build: ${JSON.stringify(result.build)}`];
+        if (project !== undefined)
+            options.push(`project: ${JSON.stringify(project)}`);
+        process.stdout.write(`${result.written.map((file) => `wrote ${file}`).join("\n")}\n\n` +
+            `Next, if astro.config.mjs doesn't have it, add the integration:\n` +
+            `  integrations: [ascribe({ ${options.join(", ")} })],\n` +
+            `then run \`npx astro dev\`.\n`);
+        return 0;
+    }
+    catch (error) {
+        process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
+        return 2;
+    }
+}
+process.exitCode = await main(process.argv.slice(2));
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,yEAAyE;AACzE,wDAAwD;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,KAAK,GAAG;;;uCAGyB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;gCAM/B,CAAC;AAEjC,SAAS,IAAI,CAAC,IAAc;IAC1B,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;YACjB,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,OAAO,EAAE;gBACP,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC3B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;aACtC;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;QAChG,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;IACvC,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;QACnC,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;QAC1D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;QACnC,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC;AAED,KAAK,UAAU,GAAG,CAAC,OAA2B,EAAE,KAAyB;IACvE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3D,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YAC/D,mEAAmE;YACnE,8BAA8B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS;YACzD,+BAA+B,CAClC,CAAC;QACF,OAAO,CAAC,CAAC;IACX,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpF,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAED,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n// `npx @ascribed/astro`: the package's command, `ascribe-astro`. Its one\n// subcommand, `init`, writes the starter (src/init.ts).\nimport { parseArgs } from \"node:util\";\nimport { init, STARTER_FILES } from \"./init.js\";\n\nconst USAGE = `Usage: npx @ascribed/astro init [--project <dir>] [--build <name>]\n\nWrites the files every site built with Ascribe starts from into the Astro\nproject in the current folder, once: ${STARTER_FILES.join(\", \")}.\nIt writes nothing if any of them is there.\n\nOptions:\n  --project <dir>   The folder holding ascribe.toml, from the current folder. Default: the current folder.\n  --build <name>    The build the site shows. Default: the project's one build.\n  -h, --help        Print this.`;\n\nfunction main(argv: string[]): Promise<number> | number {\n  let parsed;\n  try {\n    parsed = parseArgs({\n      args: argv,\n      allowPositionals: true,\n      options: {\n        project: { type: \"string\" },\n        build: { type: \"string\" },\n        help: { type: \"boolean\", short: \"h\" },\n      },\n    });\n  } catch (error) {\n    process.stderr.write(`${error instanceof Error ? error.message : String(error)}\\n\\n${USAGE}\\n`);\n    return 2;\n  }\n  const { values, positionals } = parsed;\n  if (values.help === true) {\n    process.stdout.write(`${USAGE}\\n`);\n    return 0;\n  }\n  if (positionals.length !== 1 || positionals[0] !== \"init\") {\n    process.stderr.write(`${USAGE}\\n`);\n    return 2;\n  }\n  return run(values.project, values.build);\n}\n\nasync function run(project: string | undefined, build: string | undefined): Promise<number> {\n  try {\n    const result = await init({ root: process.cwd(), project, build });\n    const options = [`build: ${JSON.stringify(result.build)}`];\n    if (project !== undefined) options.push(`project: ${JSON.stringify(project)}`);\n    process.stdout.write(\n      `${result.written.map((file) => `wrote ${file}`).join(\"\\n\")}\\n\\n` +\n        `Next, if astro.config.mjs doesn't have it, add the integration:\\n` +\n        `  integrations: [ascribe({ ${options.join(\", \")} })],\\n` +\n        `then run \\`npx astro dev\\`.\\n`,\n    );\n    return 0;\n  } catch (error) {\n    process.stderr.write(`${error instanceof Error ? error.message : String(error)}\\n`);\n    return 2;\n  }\n}\n\nprocess.exitCode = await main(process.argv.slice(2));\n"]}

package/dist/content.d.ts

@@ -1,4 +1,9 @@
 import { glob } from "astro/loaders";
+import { type PageRecord } from "./records.js";
+import { type NavEntry, type NavGroup, type SidebarGroup } from "./nav.js";
+export type { NavGroup, SidebarGroup, SidebarPage } from "./nav.js";
+export type { Listing, ListingFrom, PageRecord, Step } from "./records.js";
+export { headTags, scriptJson, type Card, type HeadOptions, type HeadTag } from "./head.js";
 /**
  * The collection's loader and schema: the `glob` loader on the site output's
  * pages, with the generated Zod schema (`_ascribe/schema.ts`'s `schema`).
@@ -17,3 +22,25 @@ export declare function ascribeCollection<S>(options: {
     loader: ReturnType<typeof glob>;
     schema: S;
 };
+/**
+ * A layout's sidebar: `nav`'s groups, each page with its collection entry and
+ * its address, which is the one Ascribe's links use. `entries` is the
+ * collection (`await getCollection("docs")`), and `name` says which project's,
+ * as for `ascribeCollection`; with several projects and no `name`, it's the one
+ * the entries were loaded from. Throws, naming each, when `nav` leaves out a page
+ * of the collection, names a file that isn't one, or names a page twice, so the
+ * build fails until the list is complete.
+ */
+export declare function sidebar<E extends NavEntry>(nav: readonly NavGroup[], entries: readonly E[], options?: {
+    name?: string;
+}): SidebarGroup<E>[];
+/**
+ * A collection entry's page record, from its build's `_ascribe/pages.json`:
+ * its route, title, description, canonical address, and listing, as every
+ * output Ascribe writes has them. `undefined` for an entry that isn't from an
+ * Ascribe collection, or whose page has no record.
+ */
+export declare function pageRecord(entry: {
+    filePath?: string | undefined;
+    data?: unknown;
+}): PageRecord | undefined;

package/dist/content.js

@@ -13,10 +13,18 @@
 //   export const collections = {
 //     docs: defineCollection(ascribeCollection({ schema: docs, name: "docs" })),
 //   };
+//
+// A layout's sidebar, from the site's list of pages (`src/nav.ts`, which
+// `npx @ascribed/astro init` writes), checked against the collection:
+//
+//   const groups = sidebar(nav, await getCollection("docs"));
 import { pathToFileURL } from "node:url";
 import path from "node:path";
 import { glob } from "astro/loaders";
-import { collections, siteRoot } from "virtual:ascribe/site";
+import { astroRoot, collections, routes, siteRoot } from "virtual:ascribe/site";
+import { recordFor } from "./records.js";
+import { pageRoute, sidebarGroups, } from "./nav.js";
+export { headTags, scriptJson } from "./head.js";
 /**
  * The collection's loader and schema: the `glob` loader on the site output's
  * pages, with the generated Zod schema (`_ascribe/schema.ts`'s `schema`).
@@ -33,6 +41,68 @@ export function ascribeCollection(options) {
     const base = pathToFileURL(rootFor(options.name) + path.sep);
     return { loader: glob({ pattern: ["**/*.md", "!_ascribe/**"], base }), schema: options.schema };
 }
+/**
+ * A layout's sidebar: `nav`'s groups, each page with its collection entry and
+ * its address, which is the one Ascribe's links use. `entries` is the
+ * collection (`await getCollection("docs")`), and `name` says which project's,
+ * as for `ascribeCollection`; with several projects and no `name`, it's the one
+ * the entries were loaded from. Throws, naming each, when `nav` leaves out a page
+ * of the collection, names a file that isn't one, or names a page twice, so the
+ * build fails until the list is complete.
+ */
+export function sidebar(nav, entries, options = {}) {
+    const root = sidebarRoot(entries, options.name);
+    const at = routes.find((route) => route.siteRoot === root);
+    const basePath = at?.basePath ?? "/";
+    const trailingSlash = at?.trailingSlash ?? "always";
+    return sidebarGroups(nav, entries, (id) => pageRoute(id, basePath, trailingSlash), (entry) => sourceFile(root, entry));
+}
+/**
+ * A collection entry's page record, from its build's `_ascribe/pages.json`:
+ * its route, title, description, canonical address, and listing, as every
+ * output Ascribe writes has them. `undefined` for an entry that isn't from an
+ * Ascribe collection, or whose page has no record.
+ */
+export function pageRecord(entry) {
+    if (entry.filePath === undefined)
+        return undefined;
+    const file = path.resolve(astroRoot, entry.filePath);
+    const roots = [...Object.values(collections), ...(siteRoot === "" ? [] : [siteRoot])];
+    const root = roots.find((candidate) => inside(candidate, file));
+    if (root === undefined)
+        return undefined;
+    const data = entry.data;
+    const source = typeof data?.source === "string"
+        ? data.source
+        : path.relative(root, file).split(path.sep).join("/");
+    return recordFor(root, source);
+}
+/**
+ * The site output root of the collection a sidebar lists: the entry `name`
+ * names, or, with several and no name, the one the entries were loaded from.
+ */
+function sidebarRoot(entries, name) {
+    const file = entries[0]?.filePath;
+    if (name === undefined && Object.keys(collections).length > 1 && file !== undefined) {
+        const from = Object.values(collections).find((root) => inside(root, file));
+        if (from !== undefined)
+            return from;
+    }
+    return rootFor(name);
+}
+/** Whether `file`, from the Astro root as an entry's `filePath` is, is under `root`. */
+function inside(root, file) {
+    const relative = path.relative(root, path.resolve(astroRoot, file));
+    return !relative.startsWith("..") && !path.isAbsolute(relative);
+}
+/** An entry's source file, by its path in the site output, which mirrors the content root. */
+function sourceFile(root, entry) {
+    if (entry.filePath === undefined)
+        return `the page ${entry.id}`;
+    return inside(root, entry.filePath)
+        ? path.relative(root, path.resolve(astroRoot, entry.filePath)).split(path.sep).join("/")
+        : entry.filePath;
+}
 /** The site output root of the entry `name` names. */
 function rootFor(name) {
     const names = Object.keys(collections);

package/dist/content.js.map

@@ -1 +1 @@
-{"version":3,"file":"content.js","sourceRoot":"","sources":["../src/content.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,6EAA6E;AAC7E,2EAA2E;AAC3E,EAAE;AACF,sDAAsD;AACtD,iEAAiE;AACjE,6EAA6E;AAC7E,0FAA0F;AAC1F,EAAE;AACF,0DAA0D;AAC1D,EAAE;AACF,4FAA4F;AAC5F,iCAAiC;AACjC,iFAAiF;AACjF,OAAO;AACP,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAI,OAAqC;IAIxE,iEAAiE;IACjE,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7D,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;AAClG,CAAC;AAED,sDAAsD;AACtD,SAAS,OAAO,CAAC,IAAwB;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACvC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACb,0DAA0D,IAAI,qHAAqH,CACpL,CAAC;QACJ,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAW,CAAW,CAAC;QACzE,MAAM,IAAI,KAAK,CACb,mGAAmG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC5I,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,0DAA0D,IAAI,mCAAmC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC1I,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["// The content collection over a build's site output. Import it from\n// `content.config.ts`, which Vite loads, so it can read what the integration\n// resolved (`virtual:ascribe/site`) instead of finding the project itself.\n//\n//   import { defineCollection } from \"astro:content\";\n//   import { ascribeCollection } from \"@ascribed/astro/content\";\n//   import { schema } from \"../.ascribe/build/site/site/_ascribe/schema.ts\";\n//   export const collections = { docs: defineCollection(ascribeCollection({ schema })) };\n//\n// With several projects, each collection names its entry:\n//\n//   import { schema as docs } from \"../.astro/integrations/_ascribed_astro/docs/schema.ts\";\n//   export const collections = {\n//     docs: defineCollection(ascribeCollection({ schema: docs, name: \"docs\" })),\n//   };\nimport { pathToFileURL } from \"node:url\";\nimport path from \"node:path\";\nimport { glob } from \"astro/loaders\";\nimport { collections, siteRoot } from \"virtual:ascribe/site\";\n\n/**\n * The collection's loader and schema: the `glob` loader on the site output's\n * pages, with the generated Zod schema (`_ascribe/schema.ts`'s `schema`).\n * With several projects (`ascribe({ projects })`), `name` says which entry's\n * site output; it can be left out when there's one entry.\n *\n * Entry ids are Astro's own (`guides/my-setup` for `Guides/My Setup.md`, `index`\n * for the root page), which is what `AstroRouter` in `ascribe-resolve`\n * computes, so a page's route is the base path plus its id, and the root page is\n * at the base path itself.\n */\nexport function ascribeCollection<S>(options: { schema: S; name?: string }): {\n  loader: ReturnType<typeof glob>;\n  schema: S;\n} {\n  // `_ascribe/` holds the schema and published files, never pages.\n  const base = pathToFileURL(rootFor(options.name) + path.sep);\n  return { loader: glob({ pattern: [\"**/*.md\", \"!_ascribe/**\"], base }), schema: options.schema };\n}\n\n/** The site output root of the entry `name` names. */\nfunction rootFor(name: string | undefined): string {\n  const names = Object.keys(collections);\n  if (names.length === 0) {\n    if (name !== undefined) {\n      throw new Error(\n        `@ascribed/astro: ascribeCollection was given the name \"${name}\", but ascribe() was given one project, which has no name. Leave out \\`name\\`, or list the project in \\`projects\\`.`,\n      );\n    }\n    return siteRoot;\n  }\n  if (name === undefined) {\n    if (names.length === 1) return collections[names[0] as string] as string;\n    throw new Error(\n      `@ascribed/astro: ascribeCollection needs a \\`name\\` when ascribe() has several projects: one of ${names.map((n) => `\"${n}\"`).join(\", \")}.`,\n    );\n  }\n  const root = collections[name];\n  if (root === undefined) {\n    throw new Error(\n      `@ascribed/astro: ascribeCollection was given the name \"${name}\", and ascribe()'s projects are ${names.map((n) => `\"${n}\"`).join(\", \")}.`,\n    );\n  }\n  return root;\n}\n"]}
+{"version":3,"file":"content.js","sourceRoot":"","sources":["../src/content.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,6EAA6E;AAC7E,2EAA2E;AAC3E,EAAE;AACF,sDAAsD;AACtD,iEAAiE;AACjE,6EAA6E;AAC7E,0FAA0F;AAC1F,EAAE;AACF,0DAA0D;AAC1D,EAAE;AACF,4FAA4F;AAC5F,iCAAiC;AACjC,iFAAiF;AACjF,OAAO;AACP,EAAE;AACF,yEAAyE;AACzE,sEAAsE;AACtE,EAAE;AACF,8DAA8D;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,EAAE,SAAS,EAAmB,MAAM,cAAc,CAAC;AAC1D,OAAO,EACL,SAAS,EACT,aAAa,GAId,MAAM,UAAU,CAAC;AAIlB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAA6C,MAAM,WAAW,CAAC;AAE5F;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAI,OAAqC;IAIxE,iEAAiE;IACjE,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7D,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;AAClG,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CACrB,GAAwB,EACxB,OAAqB,EACrB,OAAO,GAAsB,EAAE;IAE/B,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,EAAE,EAAE,QAAQ,IAAI,GAAG,CAAC;IACrC,MAAM,aAAa,GAAG,EAAE,EAAE,aAAa,IAAI,QAAQ,CAAC;IACpD,OAAO,aAAa,CAClB,GAAG,EACH,OAAO,EACP,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,EAC9C,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CACnC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAG1B;IACC,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACnD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACtF,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAChE,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAwC,CAAC;IAC5D,MAAM,MAAM,GACV,OAAO,IAAI,EAAE,MAAM,KAAK,QAAQ;QAC9B,CAAC,CAAC,IAAI,CAAC,MAAM;QACb,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1D,OAAO,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,OAA4B,EAAE,IAAwB;IACzE,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;IAClC,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACpF,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC3E,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;IACtC,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AAED,wFAAwF;AACxF,SAAS,MAAM,CAAC,IAAY,EAAE,IAAY;IACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;AAClE,CAAC;AAED,8FAA8F;AAC9F,SAAS,UAAU,CAAC,IAAY,EAAE,KAAe;IAC/C,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,YAAY,KAAK,CAAC,EAAE,EAAE,CAAC;IAChE,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC;QACjC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACxF,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;AACrB,CAAC;AAED,sDAAsD;AACtD,SAAS,OAAO,CAAC,IAAwB;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACvC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACb,0DAA0D,IAAI,qHAAqH,CACpL,CAAC;QACJ,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAW,CAAW,CAAC;QACzE,MAAM,IAAI,KAAK,CACb,mGAAmG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC5I,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,0DAA0D,IAAI,mCAAmC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC1I,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["// The content collection over a build's site output. Import it from\n// `content.config.ts`, which Vite loads, so it can read what the integration\n// resolved (`virtual:ascribe/site`) instead of finding the project itself.\n//\n//   import { defineCollection } from \"astro:content\";\n//   import { ascribeCollection } from \"@ascribed/astro/content\";\n//   import { schema } from \"../.ascribe/build/site/site/_ascribe/schema.ts\";\n//   export const collections = { docs: defineCollection(ascribeCollection({ schema })) };\n//\n// With several projects, each collection names its entry:\n//\n//   import { schema as docs } from \"../.astro/integrations/_ascribed_astro/docs/schema.ts\";\n//   export const collections = {\n//     docs: defineCollection(ascribeCollection({ schema: docs, name: \"docs\" })),\n//   };\n//\n// A layout's sidebar, from the site's list of pages (`src/nav.ts`, which\n// `npx @ascribed/astro init` writes), checked against the collection:\n//\n//   const groups = sidebar(nav, await getCollection(\"docs\"));\nimport { pathToFileURL } from \"node:url\";\nimport path from \"node:path\";\nimport { glob } from \"astro/loaders\";\nimport { astroRoot, collections, routes, siteRoot } from \"virtual:ascribe/site\";\nimport { recordFor, type PageRecord } from \"./records.js\";\nimport {\n  pageRoute,\n  sidebarGroups,\n  type NavEntry,\n  type NavGroup,\n  type SidebarGroup,\n} from \"./nav.js\";\n\nexport type { NavGroup, SidebarGroup, SidebarPage } from \"./nav.js\";\nexport type { Listing, ListingFrom, PageRecord, Step } from \"./records.js\";\nexport { headTags, scriptJson, type Card, type HeadOptions, type HeadTag } from \"./head.js\";\n\n/**\n * The collection's loader and schema: the `glob` loader on the site output's\n * pages, with the generated Zod schema (`_ascribe/schema.ts`'s `schema`).\n * With several projects (`ascribe({ projects })`), `name` says which entry's\n * site output; it can be left out when there's one entry.\n *\n * Entry ids are Astro's own (`guides/my-setup` for `Guides/My Setup.md`, `index`\n * for the root page), which is what `AstroRouter` in `ascribe-resolve`\n * computes, so a page's route is the base path plus its id, and the root page is\n * at the base path itself.\n */\nexport function ascribeCollection<S>(options: { schema: S; name?: string }): {\n  loader: ReturnType<typeof glob>;\n  schema: S;\n} {\n  // `_ascribe/` holds the schema and published files, never pages.\n  const base = pathToFileURL(rootFor(options.name) + path.sep);\n  return { loader: glob({ pattern: [\"**/*.md\", \"!_ascribe/**\"], base }), schema: options.schema };\n}\n\n/**\n * A layout's sidebar: `nav`'s groups, each page with its collection entry and\n * its address, which is the one Ascribe's links use. `entries` is the\n * collection (`await getCollection(\"docs\")`), and `name` says which project's,\n * as for `ascribeCollection`; with several projects and no `name`, it's the one\n * the entries were loaded from. Throws, naming each, when `nav` leaves out a page\n * of the collection, names a file that isn't one, or names a page twice, so the\n * build fails until the list is complete.\n */\nexport function sidebar<E extends NavEntry>(\n  nav: readonly NavGroup[],\n  entries: readonly E[],\n  options: { name?: string } = {},\n): SidebarGroup<E>[] {\n  const root = sidebarRoot(entries, options.name);\n  const at = routes.find((route) => route.siteRoot === root);\n  const basePath = at?.basePath ?? \"/\";\n  const trailingSlash = at?.trailingSlash ?? \"always\";\n  return sidebarGroups(\n    nav,\n    entries,\n    (id) => pageRoute(id, basePath, trailingSlash),\n    (entry) => sourceFile(root, entry),\n  );\n}\n\n/**\n * A collection entry's page record, from its build's `_ascribe/pages.json`:\n * its route, title, description, canonical address, and listing, as every\n * output Ascribe writes has them. `undefined` for an entry that isn't from an\n * Ascribe collection, or whose page has no record.\n */\nexport function pageRecord(entry: {\n  filePath?: string | undefined;\n  data?: unknown;\n}): PageRecord | undefined {\n  if (entry.filePath === undefined) return undefined;\n  const file = path.resolve(astroRoot, entry.filePath);\n  const roots = [...Object.values(collections), ...(siteRoot === \"\" ? [] : [siteRoot])];\n  const root = roots.find((candidate) => inside(candidate, file));\n  if (root === undefined) return undefined;\n  const data = entry.data as { source?: unknown } | undefined;\n  const source =\n    typeof data?.source === \"string\"\n      ? data.source\n      : path.relative(root, file).split(path.sep).join(\"/\");\n  return recordFor(root, source);\n}\n\n/**\n * The site output root of the collection a sidebar lists: the entry `name`\n * names, or, with several and no name, the one the entries were loaded from.\n */\nfunction sidebarRoot(entries: readonly NavEntry[], name: string | undefined): string {\n  const file = entries[0]?.filePath;\n  if (name === undefined && Object.keys(collections).length > 1 && file !== undefined) {\n    const from = Object.values(collections).find((root) => inside(root, file));\n    if (from !== undefined) return from;\n  }\n  return rootFor(name);\n}\n\n/** Whether `file`, from the Astro root as an entry's `filePath` is, is under `root`. */\nfunction inside(root: string, file: string): boolean {\n  const relative = path.relative(root, path.resolve(astroRoot, file));\n  return !relative.startsWith(\"..\") && !path.isAbsolute(relative);\n}\n\n/** An entry's source file, by its path in the site output, which mirrors the content root. */\nfunction sourceFile(root: string, entry: NavEntry): string {\n  if (entry.filePath === undefined) return `the page ${entry.id}`;\n  return inside(root, entry.filePath)\n    ? path.relative(root, path.resolve(astroRoot, entry.filePath)).split(path.sep).join(\"/\")\n    : entry.filePath;\n}\n\n/** The site output root of the entry `name` names. */\nfunction rootFor(name: string | undefined): string {\n  const names = Object.keys(collections);\n  if (names.length === 0) {\n    if (name !== undefined) {\n      throw new Error(\n        `@ascribed/astro: ascribeCollection was given the name \"${name}\", but ascribe() was given one project, which has no name. Leave out \\`name\\`, or list the project in \\`projects\\`.`,\n      );\n    }\n    return siteRoot;\n  }\n  if (name === undefined) {\n    if (names.length === 1) return collections[names[0] as string] as string;\n    throw new Error(\n      `@ascribed/astro: ascribeCollection needs a \\`name\\` when ascribe() has several projects: one of ${names.map((n) => `\"${n}\"`).join(\", \")}.`,\n    );\n  }\n  const root = collections[name];\n  if (root === undefined) {\n    throw new Error(\n      `@ascribed/astro: ascribeCollection was given the name \"${name}\", and ascribe()'s projects are ${names.map((n) => `\"${n}\"`).join(\", \")}.`,\n    );\n  }\n  return root;\n}\n"]}

package/dist/files.d.ts

@@ -14,6 +14,9 @@ export declare function copyAgentFiles(plainRoot: string, outDir: URL, folder?:
 type Middleware = (req: IncomingMessage, res: ServerResponse, next: () => void) => void;
 /** A dev-server middleware serving the published files at `<base>_ascribe/files/`, `base` being the project's base path. */
 export declare function filesMiddleware(siteRoot: string, base: string): Middleware;
-/** A dev-server middleware serving the plain output for agents at `<base>`: `llms.txt`, each page's `.md`, and their files. */
-export declare function agentsMiddleware(plainRoot: string, base: string): Middleware;
+/**
+ * A dev-server middleware serving the plain output for agents at `<base>`: `llms.txt`, each page's
+ * `.md`, and their files, each with the headers `headers` gives its path from the host's root.
+ */
+export declare function agentsMiddleware(plainRoot: string, base: string, headers?: (pathname: string) => Record<string, string>): Middleware;
 export {};

package/dist/files.js

@@ -65,12 +65,18 @@ const TYPES = {
 export function filesMiddleware(siteRoot, base) {
     return directoryMiddleware(publishedDir(siteRoot), `${base}_ascribe/files/`);
 }
-/** A dev-server middleware serving the plain output for agents at `<base>`: `llms.txt`, each page's `.md`, and their files. */
-export function agentsMiddleware(plainRoot, base) {
-    return directoryMiddleware(plainRoot, base);
+/**
+ * A dev-server middleware serving the plain output for agents at `<base>`: `llms.txt`, each page's
+ * `.md`, and their files, each with the headers `headers` gives its path from the host's root.
+ */
+export function agentsMiddleware(plainRoot, base, headers = () => ({})) {
+    return directoryMiddleware(plainRoot, base, headers);
 }
-/** A middleware serving the files in `root` at the URL path `prefix`, which ends in `/`. */
-function directoryMiddleware(root, prefix) {
+/**
+ * A middleware serving the files in `root` at the URL path `prefix`, which ends in `/`, each with
+ * the headers `headers` gives its path.
+ */
+function directoryMiddleware(root, prefix, headers = () => ({})) {
     // Only under the base path, as in the build. Vite strips the base from
     // `req.url` before a plugin's middleware runs, but connect keeps the original in `originalUrl`.
     return (req, res, next) => {
@@ -92,6 +98,8 @@ function directoryMiddleware(root, prefix) {
                 return next();
             res.setHeader("Content-Type", TYPES[path.extname(file).toLowerCase()] ?? "application/octet-stream");
             res.setHeader("Content-Length", info.size);
+            for (const [name, value] of Object.entries(headers(pathname)))
+                res.setHeader(name, value);
             if (req.method === "HEAD")
                 return void res.end();
             createReadStream(file).pipe(res);

package/dist/files.js.map

@@ -1 +1 @@
-{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,sDAAsD;AACtD,4EAA4E;AAC5E,+EAA+E;AAC/E,2EAA2E;AAC3E,6BAA6B;AAC7B,EAAE;AACF,2EAA2E;AAC3E,6EAA6E;AAC7E,2BAA2B;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,kEAAkE;AAClE,SAAS,YAAY,CAAC,QAAgB;IACpC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,QAAgB,EAAE,SAAiB;IAC7D,MAAM,IAAI,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,QAAgB,EAChB,MAAW,EACX,MAAM,GAAG,EAAE;IAEX,OAAO,aAAa,CAClB,YAAY,CAAC,QAAQ,CAAC,EACtB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,uHAAuH;AACvH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,SAAiB,EACjB,MAAW,EACX,MAAM,GAAG,EAAE;IAEX,OAAO,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,IAAY,EAAE,EAAU;IACnD,IACE,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CACrB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,EACtB,GAAG,EAAE,CAAC,KAAK,CACZ,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,KAAK,GAA2B;IACpC,MAAM,EAAE,iBAAiB;IACzB,MAAM,EAAE,iBAAiB;IACzB,OAAO,EAAE,kBAAkB;IAC3B,OAAO,EAAE,0BAA0B;IACnC,MAAM,EAAE,0BAA0B;IAClC,MAAM,EAAE,2BAA2B;IACnC,MAAM,EAAE,yBAAyB;IACjC,KAAK,EAAE,8BAA8B;IACrC,OAAO,EAAE,0BAA0B;IACnC,MAAM,EAAE,yBAAyB;IACjC,KAAK,EAAE,gCAAgC;IACvC,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,eAAe;CACxB,CAAC;AAIF,4HAA4H;AAC5H,MAAM,UAAU,eAAe,CAAC,QAAgB,EAAE,IAAY;IAC5D,OAAO,mBAAmB,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,iBAAiB,CAAC,CAAC;AAC/E,CAAC;AAED,+HAA+H;AAC/H,MAAM,UAAU,gBAAgB,CAAC,SAAiB,EAAE,IAAY;IAC9D,OAAO,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC9C,CAAC;AAED,4FAA4F;AAC5F,SAAS,mBAAmB,CAAC,IAAY,EAAE,MAAc;IACvD,uEAAuE;IACvE,gGAAgG;IAChG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACxB,MAAM,QAAQ,GACZ,CAAE,GAAgC,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7F,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC;YACjF,OAAO,IAAI,EAAE,CAAC;QAChB,IAAI,QAAgB,CAAC;QACrB,IAAI,CAAC;YACH,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,EAAE,CAAC;QACtE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CACb,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAAE,OAAO,IAAI,EAAE,CAAC;YAClC,GAAG,CAAC,SAAS,CACX,cAAc,EACd,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,0BAA0B,CACtE,CAAC;YACF,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC;YACjD,gBAAgB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,EACD,GAAG,EAAE,CAAC,IAAI,EAAE,CACb,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC","sourcesContent":["// Serving `_ascribe/files/`: the files pages link to that aren't pages or\n// images. Astro doesn't copy them, so the integration\n// does: into the build's output directory, and in dev through a middleware.\n// Both put them at `<base-path>_ascribe/files/`, the URL the site output links\n// to, where `<base-path>` is the project's `[consumer] base-path`: Astro's\n// `base` or a path under it.\n//\n// With `[consumer] agents = true`, the same for the plain output, which is\n// laid out by URL: `llms.txt`, each page's Markdown, and their files, all at\n// `<base-path>` and below.\nimport { createReadStream } from \"node:fs\";\nimport { cp, stat } from \"node:fs/promises\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport { normalizeBase } from \"./project.js\";\n\n/** The directory of published files inside a site output root. */\nfunction publishedDir(siteRoot: string): string {\n  return path.join(siteRoot, \"_ascribe\", \"files\");\n}\n\n/**\n * The base path's folder in Astro's build output, which is at Astro's `base`:\n * `docs/` for a base path of `/docs/` under a `base` of `/`, `\"\"` when they're the same.\n */\nexport function folderUnder(basePath: string, astroBase: string): string {\n  const root = normalizeBase(astroBase);\n  return basePath.startsWith(root) ? basePath.slice(root.length) : \"\";\n}\n\n/**\n * Copies the published files to `<outDir>/<folder>_ascribe/files/`, `folder` being the\n * base path's (`folderUnder`). Returns whether there were any.\n */\nexport async function copyPublishedFiles(\n  siteRoot: string,\n  outDir: URL,\n  folder = \"\",\n): Promise<boolean> {\n  return copyDirectory(\n    publishedDir(siteRoot),\n    path.join(fileURLToPath(outDir), folder, \"_ascribe\", \"files\"),\n  );\n}\n\n/** Copies the plain output for agents to the base path's folder of the build output. Returns whether there was one. */\nexport async function copyAgentFiles(\n  plainRoot: string,\n  outDir: URL,\n  folder = \"\",\n): Promise<boolean> {\n  return copyDirectory(plainRoot, path.join(fileURLToPath(outDir), folder));\n}\n\nasync function copyDirectory(from: string, to: string): Promise<boolean> {\n  if (\n    !(await stat(from).then(\n      (s) => s.isDirectory(),\n      () => false,\n    ))\n  )\n    return false;\n  await cp(from, to, { recursive: true });\n  return true;\n}\n\nconst TYPES: Record<string, string> = {\n  \".pdf\": \"application/pdf\",\n  \".zip\": \"application/zip\",\n  \".json\": \"application/json\",\n  \".yaml\": \"text/yaml; charset=utf-8\",\n  \".yml\": \"text/yaml; charset=utf-8\",\n  \".txt\": \"text/plain; charset=utf-8\",\n  \".csv\": \"text/csv; charset=utf-8\",\n  \".md\": \"text/markdown; charset=utf-8\",\n  \".html\": \"text/html; charset=utf-8\",\n  \".css\": \"text/css; charset=utf-8\",\n  \".js\": \"text/javascript; charset=utf-8\",\n  \".png\": \"image/png\",\n  \".jpg\": \"image/jpeg\",\n  \".jpeg\": \"image/jpeg\",\n  \".gif\": \"image/gif\",\n  \".webp\": \"image/webp\",\n  \".svg\": \"image/svg+xml\",\n};\n\ntype Middleware = (req: IncomingMessage, res: ServerResponse, next: () => void) => void;\n\n/** A dev-server middleware serving the published files at `<base>_ascribe/files/`, `base` being the project's base path. */\nexport function filesMiddleware(siteRoot: string, base: string): Middleware {\n  return directoryMiddleware(publishedDir(siteRoot), `${base}_ascribe/files/`);\n}\n\n/** A dev-server middleware serving the plain output for agents at `<base>`: `llms.txt`, each page's `.md`, and their files. */\nexport function agentsMiddleware(plainRoot: string, base: string): Middleware {\n  return directoryMiddleware(plainRoot, base);\n}\n\n/** A middleware serving the files in `root` at the URL path `prefix`, which ends in `/`. */\nfunction directoryMiddleware(root: string, prefix: string): Middleware {\n  // Only under the base path, as in the build. Vite strips the base from\n  // `req.url` before a plugin's middleware runs, but connect keeps the original in `originalUrl`.\n  return (req, res, next) => {\n    const pathname =\n      ((req as { originalUrl?: string }).originalUrl ?? req.url ?? \"\").split(/[?#]/, 1)[0] ?? \"\";\n    if (!pathname.startsWith(prefix) || (req.method !== \"GET\" && req.method !== \"HEAD\"))\n      return next();\n    let relative: string;\n    try {\n      relative = decodeURIComponent(pathname.slice(prefix.length));\n    } catch {\n      return next();\n    }\n    const file = path.resolve(root, relative);\n    if (file !== root && !file.startsWith(root + path.sep)) return next();\n    stat(file).then(\n      (info) => {\n        if (!info.isFile()) return next();\n        res.setHeader(\n          \"Content-Type\",\n          TYPES[path.extname(file).toLowerCase()] ?? \"application/octet-stream\",\n        );\n        res.setHeader(\"Content-Length\", info.size);\n        if (req.method === \"HEAD\") return void res.end();\n        createReadStream(file).pipe(res);\n      },\n      () => next(),\n    );\n  };\n}\n"]}
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,sDAAsD;AACtD,4EAA4E;AAC5E,+EAA+E;AAC/E,2EAA2E;AAC3E,6BAA6B;AAC7B,EAAE;AACF,2EAA2E;AAC3E,6EAA6E;AAC7E,2BAA2B;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,kEAAkE;AAClE,SAAS,YAAY,CAAC,QAAgB;IACpC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,QAAgB,EAAE,SAAiB;IAC7D,MAAM,IAAI,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IACtC,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACtE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,QAAgB,EAChB,MAAW,EACX,MAAM,GAAG,EAAE;IAEX,OAAO,aAAa,CAClB,YAAY,CAAC,QAAQ,CAAC,EACtB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,uHAAuH;AACvH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,SAAiB,EACjB,MAAW,EACX,MAAM,GAAG,EAAE;IAEX,OAAO,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,IAAY,EAAE,EAAU;IACnD,IACE,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CACrB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,EACtB,GAAG,EAAE,CAAC,KAAK,CACZ,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,KAAK,GAA2B;IACpC,MAAM,EAAE,iBAAiB;IACzB,MAAM,EAAE,iBAAiB;IACzB,OAAO,EAAE,kBAAkB;IAC3B,OAAO,EAAE,0BAA0B;IACnC,MAAM,EAAE,0BAA0B;IAClC,MAAM,EAAE,2BAA2B;IACnC,MAAM,EAAE,yBAAyB;IACjC,KAAK,EAAE,8BAA8B;IACrC,OAAO,EAAE,0BAA0B;IACnC,MAAM,EAAE,yBAAyB;IACjC,KAAK,EAAE,gCAAgC;IACvC,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,eAAe;CACxB,CAAC;AAIF,4HAA4H;AAC5H,MAAM,UAAU,eAAe,CAAC,QAAgB,EAAE,IAAY;IAC5D,OAAO,mBAAmB,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,iBAAiB,CAAC,CAAC;AAC/E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,SAAiB,EACjB,IAAY,EACZ,OAAO,GAAiD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;IAElE,OAAO,mBAAmB,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,IAAY,EACZ,MAAc,EACd,OAAO,GAAiD,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;IAElE,uEAAuE;IACvE,gGAAgG;IAChG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACxB,MAAM,QAAQ,GACZ,CAAE,GAAgC,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7F,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC;YACjF,OAAO,IAAI,EAAE,CAAC;QAChB,IAAI,QAAgB,CAAC;QACrB,IAAI,CAAC;YACH,QAAQ,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,EAAE,CAAC;QACtE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CACb,CAAC,IAAI,EAAE,EAAE;YACP,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAAE,OAAO,IAAI,EAAE,CAAC;YAClC,GAAG,CAAC,SAAS,CACX,cAAc,EACd,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,0BAA0B,CACtE,CAAC;YACF,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC1F,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC;YACjD,gBAAgB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,EACD,GAAG,EAAE,CAAC,IAAI,EAAE,CACb,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC","sourcesContent":["// Serving `_ascribe/files/`: the files pages link to that aren't pages or\n// images. Astro doesn't copy them, so the integration\n// does: into the build's output directory, and in dev through a middleware.\n// Both put them at `<base-path>_ascribe/files/`, the URL the site output links\n// to, where `<base-path>` is the project's `[consumer] base-path`: Astro's\n// `base` or a path under it.\n//\n// With `[consumer] agents = true`, the same for the plain output, which is\n// laid out by URL: `llms.txt`, each page's Markdown, and their files, all at\n// `<base-path>` and below.\nimport { createReadStream } from \"node:fs\";\nimport { cp, stat } from \"node:fs/promises\";\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport { normalizeBase } from \"./project.js\";\n\n/** The directory of published files inside a site output root. */\nfunction publishedDir(siteRoot: string): string {\n  return path.join(siteRoot, \"_ascribe\", \"files\");\n}\n\n/**\n * The base path's folder in Astro's build output, which is at Astro's `base`:\n * `docs/` for a base path of `/docs/` under a `base` of `/`, `\"\"` when they're the same.\n */\nexport function folderUnder(basePath: string, astroBase: string): string {\n  const root = normalizeBase(astroBase);\n  return basePath.startsWith(root) ? basePath.slice(root.length) : \"\";\n}\n\n/**\n * Copies the published files to `<outDir>/<folder>_ascribe/files/`, `folder` being the\n * base path's (`folderUnder`). Returns whether there were any.\n */\nexport async function copyPublishedFiles(\n  siteRoot: string,\n  outDir: URL,\n  folder = \"\",\n): Promise<boolean> {\n  return copyDirectory(\n    publishedDir(siteRoot),\n    path.join(fileURLToPath(outDir), folder, \"_ascribe\", \"files\"),\n  );\n}\n\n/** Copies the plain output for agents to the base path's folder of the build output. Returns whether there was one. */\nexport async function copyAgentFiles(\n  plainRoot: string,\n  outDir: URL,\n  folder = \"\",\n): Promise<boolean> {\n  return copyDirectory(plainRoot, path.join(fileURLToPath(outDir), folder));\n}\n\nasync function copyDirectory(from: string, to: string): Promise<boolean> {\n  if (\n    !(await stat(from).then(\n      (s) => s.isDirectory(),\n      () => false,\n    ))\n  )\n    return false;\n  await cp(from, to, { recursive: true });\n  return true;\n}\n\nconst TYPES: Record<string, string> = {\n  \".pdf\": \"application/pdf\",\n  \".zip\": \"application/zip\",\n  \".json\": \"application/json\",\n  \".yaml\": \"text/yaml; charset=utf-8\",\n  \".yml\": \"text/yaml; charset=utf-8\",\n  \".txt\": \"text/plain; charset=utf-8\",\n  \".csv\": \"text/csv; charset=utf-8\",\n  \".md\": \"text/markdown; charset=utf-8\",\n  \".html\": \"text/html; charset=utf-8\",\n  \".css\": \"text/css; charset=utf-8\",\n  \".js\": \"text/javascript; charset=utf-8\",\n  \".png\": \"image/png\",\n  \".jpg\": \"image/jpeg\",\n  \".jpeg\": \"image/jpeg\",\n  \".gif\": \"image/gif\",\n  \".webp\": \"image/webp\",\n  \".svg\": \"image/svg+xml\",\n};\n\ntype Middleware = (req: IncomingMessage, res: ServerResponse, next: () => void) => void;\n\n/** A dev-server middleware serving the published files at `<base>_ascribe/files/`, `base` being the project's base path. */\nexport function filesMiddleware(siteRoot: string, base: string): Middleware {\n  return directoryMiddleware(publishedDir(siteRoot), `${base}_ascribe/files/`);\n}\n\n/**\n * A dev-server middleware serving the plain output for agents at `<base>`: `llms.txt`, each page's\n * `.md`, and their files, each with the headers `headers` gives its path from the host's root.\n */\nexport function agentsMiddleware(\n  plainRoot: string,\n  base: string,\n  headers: (pathname: string) => Record<string, string> = () => ({}),\n): Middleware {\n  return directoryMiddleware(plainRoot, base, headers);\n}\n\n/**\n * A middleware serving the files in `root` at the URL path `prefix`, which ends in `/`, each with\n * the headers `headers` gives its path.\n */\nfunction directoryMiddleware(\n  root: string,\n  prefix: string,\n  headers: (pathname: string) => Record<string, string> = () => ({}),\n): Middleware {\n  // Only under the base path, as in the build. Vite strips the base from\n  // `req.url` before a plugin's middleware runs, but connect keeps the original in `originalUrl`.\n  return (req, res, next) => {\n    const pathname =\n      ((req as { originalUrl?: string }).originalUrl ?? req.url ?? \"\").split(/[?#]/, 1)[0] ?? \"\";\n    if (!pathname.startsWith(prefix) || (req.method !== \"GET\" && req.method !== \"HEAD\"))\n      return next();\n    let relative: string;\n    try {\n      relative = decodeURIComponent(pathname.slice(prefix.length));\n    } catch {\n      return next();\n    }\n    const file = path.resolve(root, relative);\n    if (file !== root && !file.startsWith(root + path.sep)) return next();\n    stat(file).then(\n      (info) => {\n        if (!info.isFile()) return next();\n        res.setHeader(\n          \"Content-Type\",\n          TYPES[path.extname(file).toLowerCase()] ?? \"application/octet-stream\",\n        );\n        res.setHeader(\"Content-Length\", info.size);\n        for (const [name, value] of Object.entries(headers(pathname))) res.setHeader(name, value);\n        if (req.method === \"HEAD\") return void res.end();\n        createReadStream(file).pipe(res);\n      },\n      () => next(),\n    );\n  };\n}\n"]}

package/dist/head-check.d.ts

@@ -0,0 +1,6 @@
+import type { MiddlewareHandler } from "astro";
+/** Where the integration leaves its logger's `warn` for this middleware, which Vite loads apart from it. */
+export declare const WARN: unique symbol;
+/** The warnings for `html`, the page at `route`: one per repeated tag not yet warned about. */
+export declare function headWarnings(html: string, route: string, seen?: Set<string>): string[];
+export declare const onRequest: MiddlewareHandler;

package/dist/head-check.js

@@ -0,0 +1,28 @@
+import { repeatedHeadTags } from "./head.js";
+/** Where the integration leaves its logger's `warn` for this middleware, which Vite loads apart from it. */
+export const WARN = Symbol.for("@ascribed/astro:head-warn");
+/** The tags already warned about. */
+const warned = new Set();
+/** The warnings for `html`, the page at `route`: one per repeated tag not yet warned about. */
+export function headWarnings(html, route, seen = warned) {
+    return repeatedHeadTags(html)
+        .filter((tag) => {
+        if (seen.has(tag))
+            return false;
+        seen.add(tag);
+        return true;
+    })
+        .map((tag) => `${route}'s head has ${tag} twice. Head.astro writes it from the page's record, so the layout doesn't need to.`);
+}
+export const onRequest = async (context, next) => {
+    const response = await next();
+    if (!(response.headers.get("content-type") ?? "").startsWith("text/html"))
+        return response;
+    const html = await response.text();
+    const warn = globalThis[WARN] ??
+        ((message) => console.warn(`[@ascribed/astro] ${message}`));
+    for (const message of headWarnings(html, context.url.pathname))
+        warn(message);
+    return new Response(html, response);
+};
+//# sourceMappingURL=head-check.js.map

package/dist/head-check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"head-check.js","sourceRoot":"","sources":["../src/head-check.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C,4GAA4G;AAC5G,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;AAE5D,qCAAqC;AACrC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;AAEjC,+FAA+F;AAC/F,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,KAAa,EAAE,IAAI,GAAgB,MAAM;IAClF,OAAO,gBAAgB,CAAC,IAAI,CAAC;SAC1B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,GAAG,CACF,CAAC,GAAG,EAAE,EAAE,CACN,GAAG,KAAK,eAAe,GAAG,qFAAqF,CAClH,CAAC;AACN,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAsB,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC3F,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,MAAM,IAAI,GACN,UAAsC,CAAC,IAAI,CAA6C;QAC1F,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,OAAO,EAAE,CAAC,CAAC,CAAC;IACtE,KAAK,MAAM,OAAO,IAAI,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;QAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9E,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC,CAAC","sourcesContent":["// `astro dev`'s check of each page's head: a tag `Head.astro` writes that the\n// head has twice, because the layout writes it too, is warned about once,\n// naming the tag. Not an error: a site may have a reason. The integration adds\n// this middleware in `astro dev` only.\nimport type { MiddlewareHandler } from \"astro\";\nimport { repeatedHeadTags } from \"./head.js\";\n\n/** Where the integration leaves its logger's `warn` for this middleware, which Vite loads apart from it. */\nexport const WARN = Symbol.for(\"@ascribed/astro:head-warn\");\n\n/** The tags already warned about. */\nconst warned = new Set<string>();\n\n/** The warnings for `html`, the page at `route`: one per repeated tag not yet warned about. */\nexport function headWarnings(html: string, route: string, seen: Set<string> = warned): string[] {\n  return repeatedHeadTags(html)\n    .filter((tag) => {\n      if (seen.has(tag)) return false;\n      seen.add(tag);\n      return true;\n    })\n    .map(\n      (tag) =>\n        `${route}'s head has ${tag} twice. Head.astro writes it from the page's record, so the layout doesn't need to.`,\n    );\n}\n\nexport const onRequest: MiddlewareHandler = async (context, next) => {\n  const response = await next();\n  if (!(response.headers.get(\"content-type\") ?? \"\").startsWith(\"text/html\")) return response;\n  const html = await response.text();\n  const warn =\n    ((globalThis as Record<symbol, unknown>)[WARN] as ((message: string) => void) | undefined) ??\n    ((message: string) => console.warn(`[@ascribed/astro] ${message}`));\n  for (const message of headWarnings(html, context.url.pathname)) warn(message);\n  return new Response(html, response);\n};\n"]}

package/dist/head.d.ts

@@ -0,0 +1,54 @@
+import type { PageRecord } from "./records.js";
+/** A page's social card: its image, what it shows, and its size in pixels. */
+export interface Card {
+    /** The image's address: absolute, or from the host's root, resolved against the site's address. */
+    src: string;
+    /** What the image shows, for a reader who can't see it. */
+    alt: string;
+    width?: number;
+    height?: number;
+}
+/** What a site says about itself, which a record doesn't hold. */
+export interface HeadOptions {
+    /** The whole title, from the page's title and its record. Default: the page's title. */
+    title?: ((title: string, record: PageRecord) => string) | undefined;
+    /** The site's name, for `og:site_name` and, on the page at the host's root, the site-name structured data. */
+    name?: string | undefined;
+    /** The page's social card. Without one, no image tags. */
+    card?: Card | undefined;
+    /** The site's address (Astro's `site`, or the request's), for addresses the record doesn't make absolute. */
+    address: string | URL;
+}
+/** One tag of the head. */
+export type HeadTag = {
+    tag: "title";
+    text: string;
+} | {
+    tag: "meta" | "link";
+    attributes: Record<string, string>;
+} | {
+    tag: "script";
+    json: unknown;
+};
+/**
+ * The tags of a page's head that are about the page, in order: the title and
+ * the description; the canonical link; the robots rule; the link to the
+ * Markdown version, when the build publishes one and the page is offered; the
+ * Open Graph tags a link preview reads, the card's among them when there is
+ * one; the breadcrumbs, as structured data, when there are two steps or more;
+ * and, on the page at the host's root, the site's name, as structured data.
+ * The title, the description, and the address are the record's, so the head
+ * can't disagree with the sitemap or `llms.txt`.
+ */
+export declare function headTags(record: PageRecord, options: HeadOptions): HeadTag[];
+/**
+ * JSON for a `<script>` element: `<` written as `\u003c`, so no string in it
+ * can close the element.
+ */
+export declare function scriptJson(json: unknown): string;
+/**
+ * The tags that a page's `<head>` has more than once, of those `Head.astro`
+ * writes, named as `<title>` or `<meta property="og:title">` are. A layout
+ * that includes the component and writes one of them too has two.
+ */
+export declare function repeatedHeadTags(html: string): string[];