@mark1russell7/site-pages 0.0.0-bootstrap.0 → 0.1.0

package/build/index.d.ts

@@ -0,0 +1,737 @@
+//#region src/data/types.d.ts
+/**
+ * The data shapes of `releases.json` and `status.json`. The standalone pages read them, and a site
+ * can read the same JSON with its own components.
+ */
+/** A link with its text, for example a pull request, a commit or a page on npm. */
+interface Link {
+  label: string;
+  url: string;
+}
+/**
+ * The kind of a version. The oldest version is "first". `X.0.0` with `X` of 1 or more is "major".
+ * A version with the PATCH number 0 is "minor". Each other version is "patch".
+ */
+type ReleaseKind = "first" | "major" | "minor" | "patch";
+/** One change of a release: one commit, and the packages whose changelogs list it. */
+interface ReleaseChange {
+  /** The short SHA of the commit, or null for an entry without a commit. */
+  commit: string | null;
+  /** The first sentence of the entry, as inline Markdown. */
+  text: string;
+  /** The npm names of the packages, sorted. */
+  packages: string[];
+}
+/** One version of the repository. `releases.json` holds an array of them, the newest version first. */
+interface Release {
+  version: string;
+  /** The ISO date of the version: from the git tag, the GitHub release, npm, or the changelog commit. */
+  date: string;
+  kind: ReleaseKind;
+  /** The changes, the change with the most packages first. */
+  changes: ReleaseChange[];
+  /** The pages of the version: the GitHub release, the changelog section and the npm page. */
+  links: Link[];
+}
+/** A release of the GitHub repository, as `githubReleases` gives it. */
+interface GitHubRelease {
+  tag: string;
+  name: string;
+  /** The text of the release, as Markdown. */
+  body: string;
+  /** The ISO date of the publication. */
+  publishedAt: string;
+  url: string;
+  prerelease: boolean;
+}
+/** The result of `githubReleases`. Without a token, or after an error, it has only the reason. */
+type GitHubReleases = {
+  available: true;
+  releases: GitHubRelease[];
+} | {
+  available: false;
+  reason: string;
+};
+/** The publication time of one version of one package on npm. */
+interface NpmVersionTime {
+  name: string;
+  version: string;
+  date: string;
+}
+/** The result of `npmPublishTimes`: the times that npm gave, and a message for each package that failed. */
+interface NpmPublishTimes {
+  times: NpmVersionTime[];
+  problems: string[];
+}
+/** The class of a status. The board shows the open classes in this sequence, and "done" last. */
+type StatusClass = "waiting" | "blocked" | "progress" | "open" | "later" | "done";
+/** One row of a table of the roadmap file. The text fields are inline Markdown. */
+interface BoardItem {
+  id: string;
+  title: string;
+  /** The text of the Status cell, as the roadmap has it. */
+  status: string;
+  statusClass: StatusClass;
+  owner?: string;
+  area?: string;
+  /** The IDs that the item needs, as the roadmap has them. */
+  needs?: string;
+  /** The nearest heading above the table, as plain text. */
+  section: string;
+  /** The line of the row in the roadmap file. */
+  line: number;
+  links: Link[];
+}
+/** The combined state of the checks of the last commit of a pull request. */
+type CheckState = "success" | "failure" | "pending" | "none";
+/** An open pull request of the repository. */
+interface BoardPullRequest {
+  number: number;
+  title: string;
+  url: string;
+  author: string;
+  branch: string;
+  draft: boolean;
+  createdAt: string;
+  updatedAt: string;
+  labels: string[];
+  checks: CheckState;
+}
+/** An open issue of the repository. */
+interface BoardIssue {
+  number: number;
+  title: string;
+  url: string;
+  author: string;
+  createdAt: string;
+  updatedAt: string;
+  labels: string[];
+}
+/** The numbers of open pull requests and open issues on GitHub. A list can hold fewer than the total. */
+interface OpenWorkTotals {
+  pullRequests: number;
+  issues: number;
+}
+/** The result of `githubOpenWork`. Without a token, or after an error, it has only the reason. */
+type GitHubOpenWork = {
+  available: true;
+  pullRequests: BoardPullRequest[];
+  issues: BoardIssue[];
+  totals: OpenWorkTotals;
+} | {
+  available: false;
+  reason: string;
+};
+/** The data of the status page, as `status.json` holds it. */
+interface StatusBoardData {
+  /** The ISO time of the build that read the data. */
+  generatedAt: string;
+  /** The commit of the build, or null. */
+  commit: string | null;
+  /** The roadmap file in the repository (null without a roadmap), and the repository on GitHub ("owner/name"). */
+  source: {
+    roadmap: string | null;
+    github: string;
+  };
+  items: BoardItem[];
+  pullRequests: BoardPullRequest[];
+  issues: BoardIssue[];
+  /** The GitHub part. When GitHub was not available, the board shows the reason. */
+  github: {
+    available: boolean;
+    reason?: string;
+    totals?: OpenWorkTotals;
+  };
+}
+//#endregion
+//#region src/data/versions.d.ts
+/** The parts of a SemVer 2.0.0 version. */
+interface ParsedVersion {
+  major: number;
+  minor: number;
+  patch: number;
+  prerelease: string[];
+}
+/** This function gives the parts of a version, or null when the text is not a SemVer version. */
+export declare function parseVersion(version: string): ParsedVersion | null;
+/**
+ * This function compares two versions by the SemVer precedence. It gives a negative number when `a`
+ * is older, a positive number when `a` is newer, and 0 for the same version. A text that is not a
+ * version comes before each version.
+ */
+export declare function compareVersions(a: string, b: string): number;
+/**
+ * This function gives the kind of a version. The oldest version of the list is "first". The caller
+ * tells if the version is the oldest.
+ */
+export declare function kindOf(version: string, oldest: boolean): ReleaseKind;
+/** The version of a git tag, and the package that the tag names (null for a tag like `v1.2.3`). */
+interface TagVersion {
+  version: string;
+  package: string | null;
+}
+/**
+ * This function reads the version of a git tag. It knows `1.2.3`, `v1.2.3` and the tags of Changesets:
+ * `name@1.2.3` and `@scope/name@1.2.3`. It gives null for another tag.
+ */
+export declare function versionOfTag(tag: string): TagVersion | null;
+//#endregion
+//#region src/data/changelog.d.ts
+/**
+ * The changelog parser. Changesets writes a section for each version in the `CHANGELOG.md` of each
+ * package. The section has a `## 0.13.2` heading and a `###` heading for each kind of change. Each
+ * change is one `- <short sha>: <text>` entry. The next lines of an entry have an indent.
+ */
+/** One entry of a changelog section or of a release text. */
+interface ChangelogEntry {
+  /** The short SHA of the commit, or null for an entry without a commit. */
+  commit: string | null;
+  /** The first sentence of the entry, with its code spans. */
+  text: string;
+}
+/** The entries of one version of a changelog. */
+interface ChangelogSection {
+  version: string;
+  /** The text of the version heading, without the `##` marks. */
+  heading: string;
+  entries: ChangelogEntry[];
+}
+/**
+ * This function gives the first sentence of a text. A full stop, a question mark or an exclamation
+ * mark ends the sentence when a space and no lowercase letter follow it.
+ *
+ * @remarks A mark in a code span does not end the sentence. A text that ends with a colon (a list
+ * follows) ends with a full stop.
+ */
+export declare function firstSentence(text: string): string;
+/**
+ * This function gives the entries of each version of a changelog, in the sequence of the file.
+ *
+ * @remarks An entry is a line that starts with "- " and the indented lines under it. An entry for a
+ * new dependency version is not a change.
+ */
+export declare function parseChangelog(markdown: string): ChangelogSection[];
+/**
+ * This function gives the changes of the text of a GitHub release: one change for each top-level
+ * list item. Fenced code is not read.
+ */
+export declare function releaseBodyEntries(body: string): ChangelogEntry[];
+/**
+ * This function gives the anchor of a heading on GitHub: lowercase, no punctuation, and a hyphen
+ * for each space. The anchor of "0.13.2" is "0132".
+ */
+export declare function headingAnchor(heading: string): string;
+//#endregion
+//#region src/data/github.d.ts
+/** The GraphQL endpoint of GitHub. */
+export declare const GITHUB_GRAPHQL = "https://api.github.com/graphql";
+/** The REST endpoint of GitHub. */
+export declare const GITHUB_API = "https://api.github.com";
+/** The options of the GitHub functions. */
+interface GitHubOptions {
+  owner: string;
+  repo: string;
+  /** A token with read access. Without it, the function sends no request. */
+  token: string | undefined;
+  /** The `fetch` function. The default is the global `fetch`. */
+  fetch?: typeof fetch;
+  /** The time limit of each request, in milliseconds. The default is 15000. */
+  timeoutMs?: number;
+}
+/** This function gives the combined check state of a commit: success, failure, pending or none. */
+export declare function checkStateOf(rollup: {
+  state?: string | null;
+} | null | undefined): CheckState;
+/**
+ * This function reads the open pull requests and issues of a repository with one GraphQL request,
+ * the most recently updated first. It gives `{ available: false, reason }` without a token or after
+ * an error. It does not throw.
+ */
+export declare function githubOpenWork(options: GitHubOptions & {
+  endpoint?: string;
+  first?: number;
+}): Promise<GitHubOpenWork>;
+/**
+ * This function reads the published releases of a repository with the REST API, the newest first.
+ * It skips the drafts. It gives `{ available: false, reason }` without a token or after an error.
+ * It does not throw.
+ *
+ * @remarks The function reads 100 releases on each page, and at most `maxPages` pages (default 10).
+ */
+export declare function githubReleases(options: GitHubOptions & {
+  endpoint?: string;
+  maxPages?: number;
+}): Promise<GitHubReleases>;
+//#endregion
+//#region src/data/npm.d.ts
+/** The public npm registry. */
+export declare const NPM_REGISTRY = "https://registry.npmjs.org";
+/** The options of `npmPublishTimes`. */
+interface NpmOptions {
+  /** The npm names of the packages, or a scope (for example `@procedures`) for all the packages of the scope. */
+  packages: readonly string[];
+  /** The `fetch` function. The default is the global `fetch`. */
+  fetch?: typeof fetch;
+  registry?: string;
+  /** The time limit of each request, in milliseconds. The default is 15000. */
+  timeoutMs?: number;
+}
+/**
+ * This function reads the publication time of each version of the packages from the npm registry.
+ * A scope (`@name`) gives each package of the scope. It does not throw. Each failure gives a
+ * message in `problems`.
+ */
+export declare function npmPublishTimes(options: NpmOptions): Promise<NpmPublishTimes>;
+//#endregion
+//#region src/data/git.d.ts
+/** A git tag and the ISO date of its creation. */
+interface TagDate {
+  tag: string;
+  date: string;
+}
+/** This function tells if the clone is shallow. A shallow clone has not all the tags and commits. */
+export declare function isShallow(repoDir: string): boolean;
+/** This function gives each tag of the repository with its date. An annotated tag has its own date. */
+export declare function gitTagDates(repoDir: string): TagDate[];
+/**
+ * This function gives the date of the oldest commit that added a version heading to a changelog,
+ * or null. The path of the changelog starts at `repoDir`.
+ */
+export declare function headingDate(repoDir: string, version: string, file: string): string | null;
+/** This function gives the full SHA of `HEAD`, or null. */
+export declare function headCommit(repoDir: string): string | null;
+/** This function gives "owner/name" of the GitHub remote "origin", or null. */
+export declare function originRepository(repoDir: string): string | null;
+//#endregion
+//#region src/data/glob.d.ts
+/**
+ * This function gives the files under `root` that match a pattern, as paths with `/` that start at
+ * `root`, sorted. It does not go into `node_modules` or `.git`.
+ */
+export declare function globFiles(root: string, pattern: string): string[];
+//#endregion
+//#region src/data/releases.d.ts
+/** An error in the release sources, for example a group without a changelog. */
+export declare class ReleaseDataError extends Error {}
+/** One changelog file and the npm name of its package. */
+interface ChangelogSource {
+  /** The npm name of the package. */
+  name: string;
+  /** The path of the file in the repository, with `/`. */
+  file: string;
+  markdown: string;
+}
+/** The sources of `mergeReleases`. Each source is optional. */
+interface ReleaseSources {
+  changelogs?: readonly ChangelogSource[];
+  githubReleases?: readonly GitHubRelease[];
+  tags?: readonly TagDate[];
+  npm?: readonly NpmVersionTime[];
+  /**
+   * The npm name of the package whose changelog gives the versions, for a monorepo with one version
+   * for all its packages. Without it, each version of each source is a version.
+   */
+  group?: string | undefined;
+  /** "owner/name" of the repository, for the links. */
+  repository?: string | undefined;
+  /** The branch or the commit of the changelog links. The default is "HEAD". */
+  ref?: string | undefined;
+  /** This function gives the date of a version without another date: the commit that added its heading. */
+  headingDate?: ((version: string, file: string) => string | null) | undefined;
+  /** The time of the build, for a version without a date. The default is the time of the call. */
+  now?: string | undefined;
+  warn?: ((message: string) => void) | undefined;
+}
+/**
+ * This function merges the release sources into one entry for each version, the newest first.
+ *
+ * - The versions: the changelog of `group`, or else each changelog version and each GitHub release.
+ * - The date: the git tag, else the GitHub release, else npm, else the commit of the changelog heading.
+ * - The changes: the changelog entries, else the list items of the GitHub release text.
+ *
+ * @throws ReleaseDataError when `group` has no changelog and other changelogs exist
+ */
+export declare function mergeReleases(sources: ReleaseSources): Release[];
+/** The default patterns of the changelog files: the first pattern that finds a file wins. */
+export declare const DEFAULT_CHANGELOGS: readonly string[];
+/**
+ * This function reads the changelog files of a repository. The npm name of each changelog comes from
+ * the `package.json` next to it, else from its folder.
+ */
+export declare function readChangelogs(repoDir: string, pattern?: string): ChangelogSource[];
+/** The options of `readReleases`. */
+interface ReadReleasesOptions {
+  /** The folder of the repository. The changelog patterns start here. */
+  repoDir: string;
+  /** "owner/name" of the repository on GitHub, for the GitHub releases and the links. */
+  repository?: string | undefined;
+  token?: string | undefined;
+  /** The glob pattern of the changelog files. The default is `DEFAULT_CHANGELOGS`. */
+  changesets?: string | undefined;
+  /** The npm names or scopes for the npm dates. */
+  packages?: readonly string[] | undefined;
+  group?: string | undefined;
+  /** The branch or the commit of the changelog links. */
+  ref?: string | undefined;
+  fetch?: typeof fetch | undefined;
+  now?: string | undefined;
+  warn?: ((message: string) => void) | undefined;
+}
+/**
+ * This function reads all the release sources of a repository and merges them. A failure of GitHub
+ * or npm does not stop it, but gives a warning.
+ *
+ * @throws ReleaseDataError when `group` has no changelog and other changelogs exist
+ */
+export declare function readReleases(options: ReadReleasesOptions): Promise<Release[]>;
+//#endregion
+//#region src/data/status.d.ts
+/** The classes of a status, in the sequence of the board. The open work comes first. */
+export declare const STATUS_CLASSES: readonly StatusClass[];
+/** The open classes, in the sequence of the board. */
+export declare const OPEN_CLASSES: readonly StatusClass[];
+/** An error in the roadmap file, with the file and the line. */
+export declare class RoadmapParseError extends Error {}
+/**
+ * This function gives the class of a free-text status: done, progress, waiting, blocked, later or
+ * open. The first keyword of the text decides. A text without a keyword ("next", "open") is open.
+ */
+export declare function statusClassOf(text: string | null | undefined): StatusClass;
+/** This function gives the cells of a table row. A "|" in a code span or after "\" is text. */
+export declare function splitRow(line: string): string[];
+/** This function gives the plain text of inline Markdown: no code marks, no emphasis, the text of each link. */
+export declare function plainText(markdown: string | null | undefined): string;
+/** A table of a Markdown file. */
+interface MarkdownTable {
+  /** The nearest heading above the table, as plain text. */
+  section: string;
+  /** The line of the header. */
+  line: number;
+  /** The header names, in lowercase plain text. */
+  header: string[];
+  rows: Array<{
+    line: number;
+    cells: string[];
+  }>;
+}
+/**
+ * This function gives the tables of a Markdown file. Each table has its header names in lowercase
+ * plain text, the nearest heading above it, the line of its header and its rows. Fenced code is not read.
+ */
+export declare function markdownTables(markdown: string): MarkdownTable[];
+/** The options of the link functions. */
+interface LinkOptions {
+  /** The path of the roadmap file in the repository. */
+  file?: string;
+  /** "owner/name" of the repository. */
+  repository?: string;
+  /** The branch or the commit of the relative links. The default is "HEAD". */
+  ref?: string;
+}
+/**
+ * This function gives the links of a cell: each Markdown link, then each bare reference in the rest
+ * of the text. A reference is a pull request ("PR #12", "#12") or a commit hash in a code span.
+ *
+ * @remarks A repository name right before a reference ("systems PR #16") applies to it and to the
+ * next references of the cell. Without a name, a reference belongs to `repository`.
+ */
+export declare function linksOf(cell: string | null | undefined, options?: LinkOptions): Link[];
+/**
+ * This function gives the items of a roadmap file: one item for each row of each table with an `ID`
+ * column and a `Status` column. The header names match without case.
+ *
+ * @remarks The title comes from `Item`, else from `Title`. `Owner`, `Area` and `Needs` are optional.
+ * `Where`, `Commit` and `Links` give the links.
+ * @throws RoadmapParseError when the cells of a row do not match the header
+ */
+export declare function roadmapItems(markdown: string, options?: LinkOptions): BoardItem[];
+/** The input of `buildStatusBoard`. */
+interface StatusBoardInput {
+  items: BoardItem[];
+  /** The result of `githubOpenWork`. */
+  github: GitHubOpenWork;
+  /** The roadmap file in the repository, or null without a roadmap. */
+  roadmap: string | null;
+  /** "owner/name" of the repository. */
+  repository: string;
+  commit?: string | null;
+  generatedAt?: string;
+}
+/** This function puts the roadmap items and the GitHub part into the shape of `status.json`. */
+export declare function buildStatusBoard(input: StatusBoardInput): StatusBoardData;
+/** The options of `readStatusBoard`. */
+interface ReadStatusBoardOptions {
+  repoDir: string;
+  /** The path of the roadmap file from `repoDir`, with `/`. Without it, the board has only the GitHub part. */
+  roadmap?: string | null | undefined;
+  owner: string;
+  repo: string;
+  token: string | undefined;
+  /** The commit of the build. The relative links of the roadmap go to it. */
+  commit?: string | null | undefined;
+  fetch?: typeof fetch | undefined;
+  generatedAt?: string | undefined;
+}
+/**
+ * This function reads the board of a repository on disk: the roadmap file, and the open work on GitHub.
+ *
+ * @throws RoadmapParseError when the roadmap has an incorrect row, or no table with an ID and a Status column
+ */
+export declare function readStatusBoard(options: ReadStatusBoardOptions): Promise<StatusBoardData>;
+//#endregion
+//#region src/render/html.d.ts
+/** This function escapes a text for HTML content and for an attribute value in double quotes. */
+export declare function escapeHtml(text: string): string;
+/**
+ * This function gives a URL that a link can hold, or null. It accepts `http:`, `https:` and
+ * `mailto:` URLs, and relative URLs. It refuses each other scheme, for example `javascript:`.
+ */
+export declare function safeUrl(url: string): string | null;
+/**
+ * This function renders inline Markdown as HTML: code spans, links, strong text and emphasis. It
+ * escapes all other text, so the result is safe.
+ */
+export declare function inlineMarkdown(markdown: string): string;
+//#endregion
+//#region src/render/dates.d.ts
+/** This function gives the start of the UTC day of a time. */
+export declare function utcDay(time: number): number;
+/** This function gives "Oct 18": the UTC day of a time or of an ISO date. */
+export declare function shortDate(date: string | number): string;
+/** This function gives "Oct 18, 2026, 19:34 UTC", or "an unknown time" for a date that is not valid. */
+export declare function longDate(date: string | number): string;
+/** This function gives "Oct 13–15", or "Sep 30–Oct 2" over the end of a month. */
+export declare function dayRange(start: number, end: number): string;
+//#endregion
+//#region src/render/theme.d.ts
+/** The options of each page. */
+interface PageOptions {
+  /** "owner/name" of the repository on GitHub. */
+  repository: string;
+  /** The path of the site home, with a `/` at the start and at the end, for example `/client/`. */
+  base: string;
+  /** The name of the site in the header. The default is the name of the repository. */
+  siteName?: string | undefined;
+  /** More CSS for the page. It comes after the default CSS, so it can change each variable. */
+  extraCss?: string | undefined;
+  /** The ISO time of the build. */
+  generatedAt: string;
+  /** The commit of the build, or null. */
+  commit: string | null;
+}
+/** The default CSS of the pages: the variables, the light and dark themes, and the parts of both pages. */
+export declare const BASE_CSS: string;
+/** The parts of one page. */
+interface PageParts {
+  /** The title of the page, for example "Releases". */
+  title: string;
+  description: string;
+  /** The page of the navigation that is current. */
+  current: "releases" | "status";
+  /** The HTML of the main content. */
+  main: string;
+  /** The ES module of the interactions. */
+  script: string;
+}
+/** This function makes the complete HTML document of a page. */
+export declare function pageShell(parts: PageParts, options: PageOptions): string;
+//#endregion
+//#region src/render/timeline.d.ts
+/** What the timeline needs of a version. */
+interface ReleasePoint {
+  version: string;
+  date: string;
+  kind: ReleaseKind;
+}
+/** The numbers of the lead line of the releases page. */
+interface ReleaseSummary {
+  versions: number;
+  major: number;
+  minor: number;
+  patch: number;
+  /** The date of the oldest and of the newest version, or null without a release. */
+  first: string | null;
+  last: string | null;
+}
+/** This function counts the versions and the kinds. The first release counts as a version only. */
+export declare function releaseSummary(releases: readonly ReleasePoint[]): ReleaseSummary;
+/** This function sorts the versions from the oldest to the newest: the sequence of the marks and of the arrow keys. */
+export declare function oldestFirst<T extends ReleasePoint>(releases: readonly T[]): T[];
+/** The options of the layout. */
+interface TimelineOptions {
+  /** The width of the SVG, in pixels. */
+  width: number;
+  /** The space at each side, for the labels of the first and the last mark. */
+  padX?: number;
+  laneHeight?: number;
+  /** The width of one character of a label (12 px monospace). */
+  charWidth?: number;
+  /** The minimum space between two labels in one lane. */
+  gap?: number;
+  /** The width of a run of days without a release, as a part of the width of a day with releases. */
+  emptyWeight?: number;
+}
+/** A band of the axis: one day with releases, or a run of days with none. */
+interface TimelineBand {
+  start: number;
+  /** The end of the band: the start of the next day. */
+  end: number;
+  x0: number;
+  x1: number;
+  label: string;
+  count: number;
+  empty: boolean;
+}
+/** One mark of the timeline. */
+interface TimelineMark<T extends ReleasePoint = ReleasePoint> {
+  release: T;
+  time: number;
+  x: number;
+  /** The lane of the mark: 0 is the lane next to the axis. */
+  lane: number;
+  /** The half width of the label and of the target of the pointer. */
+  half: number;
+}
+/** The layout of the timeline at one width. */
+interface TimelineLayout<T extends ReleasePoint = ReleasePoint> {
+  width: number;
+  height: number;
+  plotTop: number;
+  /** The y of the axis line. */
+  plotBottom: number;
+  laneHeight: number;
+  lanes: number;
+  bands: TimelineBand[];
+  /** The marks from the oldest to the newest. */
+  marks: Array<TimelineMark<T>>;
+}
+/** This function gives the y of the center line of a lane. */
+export declare function laneCenter(layout: {
+  plotBottom: number;
+  laneHeight: number;
+}, lane: number): number;
+/** This function calculates the layout of the timeline at a width. */
+export declare function timelineLayout<T extends ReleasePoint>(releases: readonly T[], options: TimelineOptions): TimelineLayout<T>;
+//#endregion
+//#region src/render/releases.d.ts
+/**
+ * This function gives the lead line of the releases page, for example "23 versions from Oct 12 to
+ * Oct 18, 2026. 7 MINOR releases and 15 PATCH releases came after the first release."
+ */
+export declare function releasesLead(releases: readonly Release[]): string;
+/**
+ * The inline module of the releases page. It selects a version on a click, with the arrow keys,
+ * Home, End, Enter and Space. It also opens the long lists and keeps the version in the URL.
+ */
+export declare const RELEASES_SCRIPT: string;
+/** This function renders the complete releases page from the data of `releases.json`. */
+export declare function renderReleasesPage(releases: readonly Release[], options: PageOptions): string;
+//#endregion
+//#region src/render/status.d.ts
+/**
+ * This function gives the lead line of the status page, for example "12 open roadmap items, 9 open
+ * pull requests and 0 open issues, read at Oct 19, 2026, 14:05 UTC from abc1234."
+ */
+export declare function statusLead(data: StatusBoardData): string;
+/** This function gives the part of a URL for a text: "The server stack (R37)" gives "the-server-stack-r37". */
+export declare function slugOf(text: string): string;
+/** A section of the roadmap, with the count of its open items and of its done items. */
+interface BoardSection {
+  slug: string;
+  label: string;
+  open: number;
+  done: number;
+}
+/** This function gives the sections of the items, in the sequence of the file. */
+export declare function sectionsOf(items: readonly BoardItem[]): BoardSection[];
+/** A group of items with one class. */
+interface ItemGroup {
+  statusClass: StatusClass;
+  items: BoardItem[];
+}
+/** This function gives the groups of the open items in the sequence of `OPEN_CLASSES`, without the empty groups. */
+export declare function openGroups(items: readonly BoardItem[]): ItemGroup[];
+/** This function counts the items of each class. */
+export declare function classCounts(items: readonly BoardItem[]): Record<StatusClass, number>;
+/**
+ * The inline module of the status page. It filters the open work by class and by section, keeps the
+ * filters in the URL, and shows the age of each GitHub time.
+ */
+export declare const STATUS_SCRIPT: string;
+/** This function renders the complete status page from the data of `status.json`. */
+export declare function renderStatusPage(data: StatusBoardData, options: PageOptions): string;
+//#endregion
+//#region src/build.d.ts
+/** An error in the command line. The CLI shows the help and exits with code 2. */
+export declare class UsageError extends Error {}
+/** The options of `build`. */
+interface BuildOptions {
+  /** The folder of the repository. Relative paths start here. */
+  repoDir: string;
+  /** "owner/name" of the repository on GitHub. */
+  repository: string;
+  /** The built output folder of the site. */
+  out: string;
+  /** The path of the site home, for example `/client/`. */
+  base: string;
+  /** The roadmap file, from `repoDir`. Without it, the status page has only the GitHub part. */
+  roadmap?: string | undefined;
+  /** The npm names or scopes for the npm dates. */
+  packages?: readonly string[] | undefined;
+  /** The glob pattern of the changelog files. */
+  changesets?: string | undefined;
+  /** The npm name of the package whose changelog gives the versions. */
+  group?: string | undefined;
+  token?: string | undefined;
+  /** The commit of the build. */
+  commit?: string | null | undefined;
+  /** A CSS file whose content each page gets after the default CSS. */
+  css?: string | undefined;
+  /** The name of the site in the header of the pages. */
+  siteName?: string | undefined;
+  /** True to write only the JSON data, without the pages. */
+  dataOnly?: boolean | undefined;
+  fetch?: typeof fetch | undefined;
+  /** The ISO time of the build. The default is the time of the call. */
+  now?: string | undefined;
+  warn?: ((message: string) => void) | undefined;
+}
+/** The result of `build`. */
+interface BuildResult {
+  /** The written files, as absolute paths. */
+  files: string[];
+  releases: Release[];
+  status: StatusBoardData;
+}
+/**
+ * This function reads the sources and writes `data/releases.json`, `data/status.json`,
+ * `releases/index.html` and `status/index.html` into the output folder.
+ *
+ * @throws ReleaseDataError or RoadmapParseError when a source on disk is not correct
+ */
+export declare function build(options: BuildOptions): Promise<BuildResult>;
+/** The help of the CLI. */
+export declare const HELP = "Usage: site-pages build --out <dir> [options]\n\nWrites <out>/data/releases.json, <out>/data/status.json, <out>/releases/index.html\nand <out>/status/index.html. Start it in the repository, after the build of the site.\n\nOptions:\n  --out <dir>           The built output folder of the site (necessary)\n  --repo <owner/name>   The GitHub repository (default: $GITHUB_REPOSITORY, else the remote \"origin\")\n  --base </name/>       The path of the site home (default: \"/<name>/\", or \"/\" for <owner>.github.io)\n  --roadmap <file>      The roadmap file (default: none, the status page has only the GitHub part)\n  --packages <names>    npm names or a @scope, separated by commas, for the npm dates\n  --changesets <glob>   The changelog files (default: packages/*/CHANGELOG.md, else CHANGELOG.md)\n  --group <name>        The npm name of the package whose changelog gives the versions\n  --token <token>       A GitHub token with read access (default: $GITHUB_TOKEN)\n  --css <file>          A CSS file for the pages, after the default CSS\n  --site-name <name>    The name of the site in the header (default: the repository name)\n  --data-only           Write only the JSON data, not the pages\n  -h, --help            Show this help\n";
+/** The input and output of `runCli`. A test gives its own values. */
+interface CliIo {
+  cwd: string;
+  env: Record<string, string | undefined>;
+  stdout: (text: string) => void;
+  stderr: (text: string) => void;
+  fetch?: typeof fetch;
+  now?: string;
+}
+/**
+ * This function reads the command line into the options of `build`.
+ *
+ * @throws UsageError when the command line is not correct
+ */
+export declare function parseBuildArgs(argv: readonly string[], io: Pick<CliIo, "cwd" | "env">): BuildOptions | "help";
+/**
+ * This function starts the CLI and gives the exit code. The code is 0 after a build, 1 when a
+ * source is not correct, and 2 for an incorrect command line.
+ */
+export declare function runCli(argv: readonly string[], io: CliIo): Promise<number>;
+//#endregion
+export type { BoardIssue, BoardItem, BoardPullRequest, BoardSection, BuildOptions, BuildResult, ChangelogEntry, ChangelogSection, ChangelogSource, CheckState, CliIo, GitHubOpenWork, GitHubOptions, GitHubRelease, GitHubReleases, ItemGroup, Link, LinkOptions, MarkdownTable, NpmOptions, NpmPublishTimes, NpmVersionTime, OpenWorkTotals, PageOptions, PageParts, ParsedVersion, ReadReleasesOptions, ReadStatusBoardOptions, Release, ReleaseChange, ReleaseKind, ReleasePoint, ReleaseSources, ReleaseSummary, StatusBoardData, StatusBoardInput, StatusClass, TagDate, TagVersion, TimelineBand, TimelineLayout, TimelineMark, TimelineOptions };
+//# sourceMappingURL=index.d.ts.map