@apimatic/cli 1.5.0 → 2.0.0-beta.1

package/lib/types/portal/config/site-config.js

@@ -0,0 +1,88 @@
+import { err, ok, Result } from 'neverthrow';
+import { UrlPath } from '../../file/urlPath.js';
+import { allOf, isWebAddress, namespace, nonEmptyString, unknownKeys } from './fields.js';
+export const PLACEHOLDER_SITE = Object.freeze({ name: 'My API', description: null });
+const KNOWN = ['name', 'url', 'description'];
+export class SiteConfig {
+    name;
+    url;
+    description;
+    constructor(name, url, description) {
+        this.name = name;
+        this.url = url;
+        this.description = description;
+    }
+    /**
+     * `suggested` fills what the block leaves out. It is the only specification's own, or null
+     * when there are several, since no one of them speaks for the portal.
+     */
+    static parse(value, path, suggested) {
+        return namespace(value, path).andThen((data) => allOf(unknownKeys(data, KNOWN, path), Result.combineWithAllErrors([
+            SiteConfig.validName(data.name, `${path}.name`, suggested),
+            SiteConfig.validUrl(data.url, `${path}.url`),
+            SiteConfig.validDescription(data.description, `${path}.description`, suggested)
+        ])).map(([name, url, description]) => new SiteConfig(name, url, description)));
+    }
+    static suggested(site) {
+        return new SiteConfig(site.name, null, site.description);
+    }
+    siteName() {
+        return this.name;
+    }
+    siteDescription() {
+        return this.description;
+    }
+    origin() {
+        return this.url;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            ...(this.url === null ? {} : { url: this.url.toString() }),
+            ...(this.description === null ? {} : { description: this.description })
+        };
+    }
+    static validName(name, path, suggested) {
+        if (name !== undefined) {
+            return nonEmptyString(name, path);
+        }
+        return suggested === null
+            ? err([`'${path}' is required when 'spec' holds more than one specification.`])
+            : ok(suggested.name);
+    }
+    // A blank description counts as none, so no page carries an empty og:description.
+    static validDescription(description, path, suggested) {
+        if (description === undefined) {
+            return ok(suggested?.description ?? null);
+        }
+        if (typeof description !== 'string') {
+            return err([`'${path}' must be a string.`]);
+        }
+        const trimmed = description.trim();
+        return ok(trimmed.length > 0 ? trimmed : null);
+    }
+    // Only the origin is accepted: the portal is hosted at the root of its host, so a path,
+    // query or fragment would produce canonical links that do not resolve.
+    static validUrl(url, path) {
+        if (url === undefined) {
+            return ok(null);
+        }
+        const origin = typeof url === 'string' ? SiteConfig.parseOrigin(url.trim()) : null;
+        return origin === null
+            ? err([
+                `'${path}' must be the address the portal is hosted at, without a path, for example 'https://docs.example.com'.`
+            ])
+            : ok(origin);
+    }
+    static parseOrigin(value) {
+        if (!isWebAddress(value)) {
+            return null;
+        }
+        const parsed = new URL(value);
+        if (parsed.pathname !== '/' || parsed.search !== '' || parsed.hash !== '') {
+            return null;
+        }
+        return new UrlPath(parsed.origin);
+    }
+}
+//# sourceMappingURL=site-config.js.map

package/lib/types/portal/config/site-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/site-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAQlG,MAAM,CAAC,MAAM,gBAAgB,GAA4B,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAE9G,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;AAE7C,MAAM,OAAO,UAAU;IAEF,IAAI;IACJ,GAAG;IACH,WAAW;IAH9B,YACmB,IAAY,EACZ,GAAmB,EACnB,WAA0B;oBAF1B,IAAI;mBACJ,GAAG;2BACH,WAAW;IAC3B,CAAC;IAEJ;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY,EAAE,SAA+B;QAC/E,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7C,KAAK,CACH,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAC9B,MAAM,CAAC,oBAAoB,CAAC;YAC1B,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,SAAS,CAAC;YAC1D,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,MAAM,CAAC;YAC5C,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,cAAc,EAAE,SAAS,CAAC;SAChF,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,CAC5E,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAmB;QACzC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC1D,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;SACxE,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,IAAa,EAAE,IAAY,EAAE,SAA+B;QACnF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,KAAK,IAAI;YACvB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,8DAA8D,CAAC,CAAC;YAC/E,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,kFAAkF;IAC1E,MAAM,CAAC,gBAAgB,CAC7B,WAAoB,EACpB,IAAY,EACZ,SAA+B;QAE/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,CAAC,SAAS,EAAE,WAAW,IAAI,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,wFAAwF;IACxF,uEAAuE;IAC/D,MAAM,CAAC,QAAQ,CAAC,GAAY,EAAE,IAAY;QAChD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnF,OAAO,MAAM,KAAK,IAAI;YACpB,CAAC,CAAC,GAAG,CAAC;gBACF,IAAI,IAAI,wGAAwG;aACjH,CAAC;YACJ,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,KAAa;QACtC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,IAAI,MAAM,CAAC,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;CACF"}

package/lib/types/portal/config/static-asset.d.ts

@@ -0,0 +1,25 @@
+import { DirectoryPath } from '../../file/directoryPath.js';
+import { FilePath } from '../../file/filePath.js';
+import { Parsed } from './fields.js';
+/** A file the block names inside `src/static/`, which the build copies to the root of the site. */
+export declare class StaticAsset {
+    /** As written, so the block serialises back to what the user typed. */
+    private readonly written;
+    private readonly relativePath;
+    /** The setting that names the file, for the report when it is missing. */
+    private readonly setting;
+    private constructor();
+    static parse(value: unknown, path: string): Parsed<StaticAsset>;
+    resolveIn(sourceDirectory: DirectoryPath): FilePath;
+    settingPath(): string;
+    /**
+     * The `static/` prefix is the site root. Each name is escaped, since a `#`, `?` or `%` in it
+     * would otherwise end or alter the path.
+     */
+    siteUrl(): string;
+    imageType(): string | null;
+    isEqual(other: StaticAsset): boolean;
+    toJSON(): string;
+    private static normalize;
+    private static isInsideStatic;
+}

package/lib/types/portal/config/static-asset.js

@@ -0,0 +1,77 @@
+import { err, ok } from 'neverthrow';
+import { FilePath } from '../../file/filePath.js';
+const STATIC_PREFIX = 'static/';
+/** The image types a browser takes for an icon, by extension, for the `type` its link carries. */
+const IMAGE_TYPES = {
+    '.ico': 'image/x-icon',
+    '.png': 'image/png',
+    '.svg': 'image/svg+xml',
+    '.jpg': 'image/jpeg',
+    '.jpeg': 'image/jpeg',
+    '.gif': 'image/gif',
+    '.webp': 'image/webp',
+    '.avif': 'image/avif'
+};
+/** A file the block names inside `src/static/`, which the build copies to the root of the site. */
+export class StaticAsset {
+    written;
+    relativePath;
+    setting;
+    constructor(
+    /** As written, so the block serialises back to what the user typed. */
+    written, relativePath, 
+    /** The setting that names the file, for the report when it is missing. */
+    setting) {
+        this.written = written;
+        this.relativePath = relativePath;
+        this.setting = setting;
+    }
+    static parse(value, path) {
+        if (typeof value !== 'string' || value.trim().length === 0) {
+            return err([`'${path}' must be a non-empty string.`]);
+        }
+        const normalized = StaticAsset.normalize(value.trim());
+        if (!StaticAsset.isInsideStatic(normalized)) {
+            return err([
+                `'${path}' must be a path relative to 'src' inside the 'static' directory, for example '${STATIC_PREFIX}images/logo.png'.`
+            ]);
+        }
+        return ok(new StaticAsset(value, normalized, path));
+    }
+    resolveIn(sourceDirectory) {
+        return FilePath.resolve(sourceDirectory, this.relativePath);
+    }
+    settingPath() {
+        return this.setting;
+    }
+    /**
+     * The `static/` prefix is the site root. Each name is escaped, since a `#`, `?` or `%` in it
+     * would otherwise end or alter the path.
+     */
+    siteUrl() {
+        return `/${this.relativePath.slice(STATIC_PREFIX.length).split('/').map(encodeURIComponent).join('/')}`;
+    }
+    imageType() {
+        const name = this.relativePath.slice(this.relativePath.lastIndexOf('/') + 1);
+        const dot = name.lastIndexOf('.');
+        return dot <= 0 ? null : IMAGE_TYPES[name.slice(dot).toLowerCase()] ?? null;
+    }
+    isEqual(other) {
+        return this.relativePath === other.relativePath;
+    }
+    toJSON() {
+        return this.written;
+    }
+    static normalize(relativePath) {
+        return relativePath.replaceAll('\\', '/').replace(/^\.\//, '');
+    }
+    // Every name after `static` must be there: `static//logo.png` finds the file on disk, and is
+    // then served as `//logo.png`, which a browser fetches from a host called `logo.png`.
+    static isInsideStatic(normalized) {
+        const [first, ...names] = normalized.split('/');
+        return (`${first}/` === STATIC_PREFIX &&
+            names.length > 0 &&
+            names.every((name) => name.trim().length > 0 && name !== '.' && name !== '..'));
+    }
+}
+//# sourceMappingURL=static-asset.js.map

package/lib/types/portal/config/static-asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"static-asset.js","sourceRoot":"","sources":["../../../../src/types/portal/config/static-asset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGlD,MAAM,aAAa,GAAG,SAAS,CAAC;AAEhC,kGAAkG;AAClG,MAAM,WAAW,GAA2B;IAC1C,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,eAAe;IACvB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,YAAY;CACtB,CAAC;AAEF,mGAAmG;AACnG,MAAM,OAAO,WAAW;IAGH,OAAO;IACP,YAAY;IAEZ,OAAO;IAL1B;IACE,uEAAuE;IACtD,OAAe,EACf,YAAoB;IACrC,0EAA0E;IACzD,OAAe;uBAHf,OAAO;4BACP,YAAY;uBAEZ,OAAO;IACvB,CAAC;IAEG,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3D,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,+BAA+B,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;gBACT,IAAI,IAAI,kFAAkF,aAAa,mBAAmB;aAC3H,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAEM,SAAS,CAAC,eAA8B;QAC7C,OAAO,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1G,CAAC;IAEM,SAAS;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;IAC9E,CAAC;IAEM,OAAO,CAAC,KAAkB;QAC/B,OAAO,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IAClD,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,YAAoB;QAC3C,OAAO,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,6FAA6F;IAC7F,sFAAsF;IAC9E,MAAM,CAAC,cAAc,CAAC,UAAkB;QAC9C,MAAM,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChD,OAAO,CACL,GAAG,KAAK,GAAG,KAAK,aAAa;YAC7B,KAAK,CAAC,MAAM,GAAG,CAAC;YAChB,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC,CAC/E,CAAC;IACJ,CAAC;CACF"}

package/lib/types/portal/content-notices.d.ts

@@ -0,0 +1,20 @@
+import { DirectoryPath } from '../file/directoryPath.js';
+import { FilePath } from '../file/filePath.js';
+import { SharedTabName } from './portal-tabs.js';
+/** What a build accepts in `content/`, but the user should hear of. */
+export interface ContentNotices {
+    /**
+     * Pages below `content/api/<slug>/` for a specification `<slug>`. The section's generated
+     * metadata lists only the reference pages, so these never appear in the sidebar.
+     */
+    hiddenPages: FilePath[];
+    /**
+     * A `nav.json` written in a case the build's glob does not match, such as `Nav.json`, and
+     * so read by nothing. Reported rather than left to sit there doing nothing.
+     */
+    ignoredNavigationFiles: FilePath[];
+    /** The folders `content/nav.json` makes tabs of, in its order; listing one is all it takes. */
+    folderTabs: DirectoryPath[];
+    /** Names more than one tab would show, which the build accepts and a reader cannot tell apart. */
+    sharedTabNames: SharedTabName[];
+}

package/lib/types/portal/content-notices.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=content-notices.js.map

package/lib/types/portal/content-notices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-notices.js","sourceRoot":"","sources":["../../../src/types/portal/content-notices.ts"],"names":[],"mappings":""}

package/lib/types/portal/content-tree.d.ts

@@ -0,0 +1,103 @@
+import { Result } from 'neverthrow';
+import { Directory } from '../file/directory.js';
+import { DirectoryPath } from '../file/directoryPath.js';
+import { FilePath } from '../file/filePath.js';
+import { ContentNotices } from './content-notices.js';
+import { GeneratedPages } from './generated-pages.js';
+import { ParsedPage } from './page.js';
+import { ContentProblem, MissingImage, PortalSpec } from './portal-source.js';
+/** Passed over by Vite's `import.meta.glob`, which the build reads the content through. */
+export declare const isSkippedByGlob: (name: string) => boolean;
+/** Whether the glob passes over `file` below `root`, which it does for a path with any such segment. */
+export declare const isSkippedWithin: (file: FilePath, root: DirectoryPath) => boolean;
+/** A file of the tree with what it holds, or undefined when it could not be read. */
+export interface ContentFile {
+    file: FilePath;
+    contents: string | undefined;
+}
+/** A page of the tree as read and parsed; `parsed` is undefined exactly where `contents` is. */
+export interface ReadPage extends ContentFile {
+    parsed: ParsedPage | undefined;
+}
+/** What `check` is handed, since the tree reads nothing: its files as read, and the images looked for on disk and not found. */
+export interface ContentRead {
+    pages: ReadPage[];
+    navigationFiles: ContentFile[];
+    missingImages: MissingImage[];
+}
+/** A page or `nav.json` a build would accept, as the checks read it. */
+export interface CheckedFile {
+    file: FilePath;
+    contents: string;
+}
+/** A tree a build would accept: what the user should hear of it, and its files as checked. */
+export interface AcceptedContent {
+    notices: ContentNotices;
+    files: CheckedFile[];
+}
+/**
+ * The `content/` directory of a portal source, held to the rules the build reads it by. It reads
+ * nothing itself: `pages` and `navigationFiles` name what `check` needs to be handed.
+ */
+export declare class ContentTree {
+    private readonly tree;
+    /** What each file is named relative to, in the messages. */
+    private readonly sourceDirectory;
+    constructor(tree: Directory, 
+    /** What each file is named relative to, in the messages. */
+    sourceDirectory: DirectoryPath);
+    /** The pages the build compiles. */
+    pages(): FilePath[];
+    /** The `nav.json` files the build reads, which its glob matches by code point. */
+    navigationFiles(): FilePath[];
+    /** Whether the build would read `file` as part of `content/`: below it, and not passed over. */
+    holds(file: FilePath): boolean;
+    /** Every problem a build would refuse the tree for, or what it would warn of, from what it is handed. */
+    check(read: ContentRead, specs: PortalSpec[], generatedPages: GeneratedPages): Result<ContentNotices, ContentProblem[]>;
+    private contentPages;
+    private isSkipped;
+    /** Every page the build accepts with its title, and what it would refuse in the front matter of the rest. */
+    private titledPages;
+    /**
+     * Every `nav.json` in the tree, validated against the directory it orders, plus any `nav.json`
+     * in a case the build does not match. One walk, because both come from the same tree, and a
+     * directory has to be seen before its file can be checked against it.
+     */
+    private navigation;
+    /**
+     * Every tab, named as the template names it, in the order a report lists them: Home, the
+     * folders the root `nav.json` lists, the generated sections, then the API reference.
+     */
+    private static tabs;
+    /** A tab by the name the template gives it: its `nav.json` title, else its index page's. */
+    private static namedTab;
+    /**
+     * Pages the build cannot serve where they are, each refused for one reason: a page with no
+     * address is not judged by one, and one at an address kept for the generated pages is not
+     * said to share it as well.
+     */
+    private static addressProblems;
+    /**
+     * Pages served at a generated section's address or below it, whether or not `apimatic.json`
+     * calls for the section. Judged by the address, as the content source computes it, rather
+     * than by the directories as written: a page in a `(group)` folder is served as if the folder
+     * were not there, and a folder's index page at the folder's own address.
+     */
+    private static reservedAddressPages;
+    /** Addresses more than one page would be served at, each with its pages in the order walked. */
+    private static sharedAddresses;
+    /**
+     * Pages inside a specification's section, below `content/api/<slug>/`. The section and each
+     * tag folder come with generated metadata that lists only the reference pages, and metadata
+     * hides whatever it does not name, so these pages never reach the sidebar. Reported rather
+     * than refused: the build still succeeds, and the fix is to move the page.
+     *
+     * Judged by the directories as written, not by the address: the page tree is keyed on the
+     * path, so `content/API/<slug>/` or a `(group)` folder on the way is a different folder that
+     * no metadata hides. An `index` page is a folder's own link rather than one of its pages, so
+     * the section's is shown, and so is one in a folder directly below it: that is where the tag
+     * folders sit, and the CLI cannot tell a tag folder from one the user made without reading
+     * the specification's tags, so it stays quiet rather than warn about a page that is shown.
+     */
+    private static hiddenPages;
+}