@ctcstack/ctcdocs-core 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 CTCStack
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,37 @@
+# @ctcstack/ctcdocs-core
+
+The configuration layer shared by the [CTCDocs](https://github.com/ctcstack/ctcdocs)
+packages: the schema of a project's `site.config.json`, the fixed project
+layout, and the allowlist of paths the synchronization pipeline may write.
+
+A project does not install this package directly — `@ctcstack/ctcdocs` and
+`@ctcstack/ctcdocs-sync` depend on it. It is documented because what it
+validates is what a project writes down.
+
+```ts
+import {
+  findProjectRoot,
+  loadSiteConfiguration,
+  PROJECT_LAYOUT,
+} from '@ctcstack/ctcdocs-core';
+
+const site = loadSiteConfiguration(findProjectRoot());
+```
+
+Two properties are worth knowing about:
+
+- **The configuration is validated, not trusted.** A hostname that is not a
+  bare HTTPS origin, two environments sharing one hostname, an ownership marker
+  that would close its own HTML comment — each fails at load rather than
+  reaching a deployment.
+- **The project layout is a fixed convention, and the generated-path allowlist
+  is a compile-time constant.** It is a security control: an allowlist a
+  project can widen is an allowlist an attacker can widen.
+
+## Documentation
+
+[Configuration reference](https://github.com/ctcstack/ctcdocs/blob/main/docs/CONFIGURATION.md)
+· [Architecture decisions](https://github.com/ctcstack/ctcdocs/tree/main/docs/ADR)
+
+Apache-2.0. `0.x`: internal in practice, and the API may move between minor
+versions.

package/dist/generated-paths.d.ts

@@ -0,0 +1,3 @@
+export declare function normalizeRepositoryPath(input: string): string | undefined;
+export declare function isGeneratedPathAllowed(input: string): boolean;
+export declare function assertGeneratedPathAllowed(input: string): void;

package/dist/generated-paths.js

@@ -0,0 +1,30 @@
+import { posix } from 'node:path';
+import { GENERATED_DIRECTORY_ALLOWLIST, GENERATED_FILE_ALLOWLIST, } from './project-layout.js';
+export function normalizeRepositoryPath(input) {
+    if (input.length === 0 || input.includes('\\') || input.startsWith('/')) {
+        return undefined;
+    }
+    const normalized = posix.normalize(input);
+    if (normalized === '.' ||
+        normalized === '..' ||
+        normalized.startsWith('../')) {
+        return undefined;
+    }
+    return normalized;
+}
+export function isGeneratedPathAllowed(input) {
+    const normalized = normalizeRepositoryPath(input);
+    if (normalized === undefined) {
+        return false;
+    }
+    if (GENERATED_FILE_ALLOWLIST.some((allowedPath) => normalized === allowedPath)) {
+        return true;
+    }
+    return GENERATED_DIRECTORY_ALLOWLIST.some((allowedDirectory) => normalized === allowedDirectory ||
+        normalized.startsWith(`${allowedDirectory}/`));
+}
+export function assertGeneratedPathAllowed(input) {
+    if (!isGeneratedPathAllowed(input)) {
+        throw new Error(`Generated output path is not allowed: ${input}`);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { GENERATED_DIRECTORY_ALLOWLIST, GENERATED_FILE_ALLOWLIST, PROJECT_LAYOUT, } from './project-layout.js';
+export { assertGeneratedPathAllowed, isGeneratedPathAllowed, normalizeRepositoryPath, } from './generated-paths.js';
+export { generatedMarkdownHeader, generatedSourceHeader, } from './ownership-markers.js';
+export { findProjectRoot, ProjectRootError } from './project-root.js';
+export { loadSiteConfiguration, parseSiteConfiguration, SiteConfigurationError, } from './site-configuration.js';
+export type { BrandConfiguration, DeploymentConfiguration, DeploymentEnvironmentConfiguration, DeploymentEnvironmentConfigurations, DeploymentVisibility, HomeConfiguration, NavigationConfiguration, SiteConfiguration, SyncConfigurationDefaults, } from './site-configuration.js';

package/dist/index.js

@@ -0,0 +1,5 @@
+export { GENERATED_DIRECTORY_ALLOWLIST, GENERATED_FILE_ALLOWLIST, PROJECT_LAYOUT, } from './project-layout.js';
+export { assertGeneratedPathAllowed, isGeneratedPathAllowed, normalizeRepositoryPath, } from './generated-paths.js';
+export { generatedMarkdownHeader, generatedSourceHeader, } from './ownership-markers.js';
+export { findProjectRoot, ProjectRootError } from './project-root.js';
+export { loadSiteConfiguration, parseSiteConfiguration, SiteConfigurationError, } from './site-configuration.js';

package/dist/ownership-markers.d.ts

@@ -0,0 +1,13 @@
+import type { SiteConfiguration } from './site-configuration.js';
+/**
+ * Ownership markers, derived from `sync.generatedBy` in the project
+ * configuration so one setting names the pipeline everywhere it signs its
+ * output. Markdown carries the HTML-comment form; generated TypeScript carries
+ * the line-comment form.
+ *
+ * They are functions of the configuration rather than constants because the
+ * platform does not own the value: it is read from the project that installed
+ * the platform, and two projects sharing this package must not share a marker.
+ */
+export declare function generatedMarkdownHeader(configuration: SiteConfiguration): string;
+export declare function generatedSourceHeader(configuration: SiteConfiguration): string;

package/dist/ownership-markers.js

@@ -0,0 +1,16 @@
+/**
+ * Ownership markers, derived from `sync.generatedBy` in the project
+ * configuration so one setting names the pipeline everywhere it signs its
+ * output. Markdown carries the HTML-comment form; generated TypeScript carries
+ * the line-comment form.
+ *
+ * They are functions of the configuration rather than constants because the
+ * platform does not own the value: it is read from the project that installed
+ * the platform, and two projects sharing this package must not share a marker.
+ */
+export function generatedMarkdownHeader(configuration) {
+    return `<!-- AUTO-GENERATED BY ${configuration.sync.generatedBy}. DO NOT EDIT. -->`;
+}
+export function generatedSourceHeader(configuration) {
+    return `// AUTO-GENERATED BY ${configuration.sync.generatedBy}. DO NOT EDIT.`;
+}

package/dist/project-layout.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Where a CTCDocs project keeps its files.
+ *
+ * The layout is a fixed convention rather than configuration, and deliberately
+ * so: the generated-path allowlist below is a security control. Sync automation
+ * fails when it writes outside it, and an allowlist a project can widen is an
+ * allowlist an attacker can widen. A project that wants a different shape forks
+ * the platform; it does not get a setting.
+ *
+ * Every path is repository-relative and POSIX-separated, because they are
+ * compared against Git paths and written into the manifest.
+ */
+export declare const PROJECT_LAYOUT: {
+    /** Identifies a project root; `findProjectRoot` walks up looking for it. */
+    readonly configurationFile: "site.config.json";
+    /** Deployment target. Wrangler reads it itself, so it cannot be generated. */
+    readonly wranglerConfigurationFile: "wrangler.jsonc";
+    /** Secret-scanning configuration, whose exemptions `validate` checks. */
+    readonly gitleaksConfigurationFile: ".gitleaks.toml";
+    /** Served verbatim by the Worker. */
+    readonly publicDirectory: "public";
+    readonly robotsFile: "public/robots.txt";
+    readonly headersFile: "public/_headers";
+    /** Generated Markdown, one directory per Drive folder. */
+    readonly generatedDocumentsDirectory: "src/content/docs/_generated";
+    /** Original images, one directory per Google file identifier. */
+    readonly generatedAssetsDirectory: "src/assets/generated";
+    /** Generated TypeScript: the sidebar and the redirect map. */
+    readonly generatedSourceDirectory: "src/generated";
+    readonly manifestFile: "data/sync-manifest.json";
+    readonly documentIndexFile: "data/docs-index.json";
+    readonly syncReportFile: "data/latest-sync-report.json";
+};
+export declare const GENERATED_DIRECTORY_ALLOWLIST: readonly ["src/content/docs/_generated", "src/assets/generated", "src/generated"];
+export declare const GENERATED_FILE_ALLOWLIST: readonly ["data/sync-manifest.json", "data/docs-index.json", "data/latest-sync-report.json"];

package/dist/project-layout.js

@@ -0,0 +1,43 @@
+/**
+ * Where a CTCDocs project keeps its files.
+ *
+ * The layout is a fixed convention rather than configuration, and deliberately
+ * so: the generated-path allowlist below is a security control. Sync automation
+ * fails when it writes outside it, and an allowlist a project can widen is an
+ * allowlist an attacker can widen. A project that wants a different shape forks
+ * the platform; it does not get a setting.
+ *
+ * Every path is repository-relative and POSIX-separated, because they are
+ * compared against Git paths and written into the manifest.
+ */
+export const PROJECT_LAYOUT = {
+    /** Identifies a project root; `findProjectRoot` walks up looking for it. */
+    configurationFile: 'site.config.json',
+    /** Deployment target. Wrangler reads it itself, so it cannot be generated. */
+    wranglerConfigurationFile: 'wrangler.jsonc',
+    /** Secret-scanning configuration, whose exemptions `validate` checks. */
+    gitleaksConfigurationFile: '.gitleaks.toml',
+    /** Served verbatim by the Worker. */
+    publicDirectory: 'public',
+    robotsFile: 'public/robots.txt',
+    headersFile: 'public/_headers',
+    /** Generated Markdown, one directory per Drive folder. */
+    generatedDocumentsDirectory: 'src/content/docs/_generated',
+    /** Original images, one directory per Google file identifier. */
+    generatedAssetsDirectory: 'src/assets/generated',
+    /** Generated TypeScript: the sidebar and the redirect map. */
+    generatedSourceDirectory: 'src/generated',
+    manifestFile: 'data/sync-manifest.json',
+    documentIndexFile: 'data/docs-index.json',
+    syncReportFile: 'data/latest-sync-report.json',
+};
+export const GENERATED_DIRECTORY_ALLOWLIST = [
+    PROJECT_LAYOUT.generatedDocumentsDirectory,
+    PROJECT_LAYOUT.generatedAssetsDirectory,
+    PROJECT_LAYOUT.generatedSourceDirectory,
+];
+export const GENERATED_FILE_ALLOWLIST = [
+    PROJECT_LAYOUT.manifestFile,
+    PROJECT_LAYOUT.documentIndexFile,
+    PROJECT_LAYOUT.syncReportFile,
+];

package/dist/project-root.d.ts

@@ -0,0 +1,10 @@
+export declare class ProjectRootError extends Error {
+    readonly name = "ProjectRootError";
+}
+/**
+ * The nearest ancestor of `from` that holds `site.config.json`, `from`
+ * included. Defaults to the working directory, which is the project root for
+ * `astro build`, for `ctcdocs-sync`, and for every script a project's
+ * `package.json` runs.
+ */
+export declare function findProjectRoot(from?: string): string;

package/dist/project-root.js

@@ -0,0 +1,34 @@
+/**
+ * Finding the project a platform package is running inside.
+ *
+ * The platform packages live in `node_modules` of a project they know nothing
+ * about. The CLI, the Astro components, and the browser suite all need the
+ * project's root — to read its configuration, to resolve generated output, to
+ * point Playwright at a corpus — and none of them can be told where it is by a
+ * relative path from their own file.
+ */
+import { existsSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { PROJECT_LAYOUT } from './project-layout.js';
+export class ProjectRootError extends Error {
+    name = 'ProjectRootError';
+}
+/**
+ * The nearest ancestor of `from` that holds `site.config.json`, `from`
+ * included. Defaults to the working directory, which is the project root for
+ * `astro build`, for `ctcdocs-sync`, and for every script a project's
+ * `package.json` runs.
+ */
+export function findProjectRoot(from = process.cwd()) {
+    let directory = resolve(from);
+    for (;;) {
+        if (existsSync(resolve(directory, PROJECT_LAYOUT.configurationFile))) {
+            return directory;
+        }
+        const parent = dirname(directory);
+        if (parent === directory) {
+            throw new ProjectRootError(`No ${PROJECT_LAYOUT.configurationFile} found in ${resolve(from)} or any parent directory. Run this from inside a CTCDocs project.`);
+        }
+        directory = parent;
+    }
+}

package/dist/site-configuration.d.ts

@@ -0,0 +1,100 @@
+export interface BrandConfiguration {
+    /** The organization or product the documentation belongs to. */
+    readonly name: string;
+    /** The site's own name: browser tab, header wordmark, home page heading. */
+    readonly siteTitle: string;
+    /** One sentence, used as the site-wide meta description. */
+    readonly siteDescription: string;
+    /** Site-root-relative path of the favicon served from `public/`. */
+    readonly faviconPath: string;
+}
+export interface HomeConfiguration {
+    /**
+     * The paragraph under the home page heading: where the documents come from
+     * and what a reader may do with them. It is whole prose rather than a name
+     * the platform assembles a sentence around, because the sentence itself is
+     * an editorial choice — how the Drive is named, whether read-only is worth
+     * saying, what a newcomer needs first.
+     */
+    readonly lede: string;
+}
+/**
+ * Who a deployment is for.
+ *
+ * `private` is a documentation site behind an identity boundary: crawlers are
+ * refused, pages ask not to be indexed, responses are cached privately, and the
+ * smoke test proves anonymous traffic is denied before anything is published.
+ * `public` is a documentation portal anyone may read, and the same checks run
+ * with their assertions inverted — a public site that has quietly become
+ * unreachable is as much a defect as a private one that has quietly become
+ * readable.
+ *
+ * It defaults to `private` because a wrong guess in that direction is
+ * recoverable and a wrong guess in the other one is a disclosure.
+ */
+export type DeploymentVisibility = 'private' | 'public';
+export interface DeploymentEnvironmentConfiguration {
+    /** Origin the environment is served from, without a trailing path. */
+    readonly url: string;
+    /** Host of `url`, which is what a Wrangler custom-domain route binds. */
+    readonly hostname: string;
+    /** Who may read this environment. Defaults to `private`. */
+    readonly visibility: DeploymentVisibility;
+}
+/**
+ * Deployment environments, keyed by Wrangler environment name.
+ *
+ * A project decides how many it wants: one deployment may promote through a
+ * development hostname, another may publish production only. `production` is
+ * the one name the platform depends on — it is the canonical site address, the
+ * origin the sync pipeline writes into generated links, and the target the
+ * smoke tests default to — so it is required and every other name is the
+ * project's own.
+ */
+export type DeploymentEnvironmentConfigurations = {
+    readonly production: DeploymentEnvironmentConfiguration;
+} & {
+    readonly [environmentName: string]: DeploymentEnvironmentConfiguration;
+};
+export interface DeploymentConfiguration {
+    /** Cloudflare Worker name; environments deploy as `<name>-<environment>`. */
+    readonly workerName: string;
+    readonly environments: DeploymentEnvironmentConfigurations;
+}
+export interface SyncConfigurationDefaults {
+    /**
+     * Named in the ownership marker of every generated file. Changing it
+     * rewrites the marker in the whole generated corpus, so it is a deliberate
+     * one-time decision for a new project rather than a cosmetic setting.
+     */
+    readonly generatedBy: string;
+    /** Git author the sync workflow commits generated output as. */
+    readonly commitBotName: string;
+    /** Locale assumed for documents whose language cannot be determined. */
+    readonly defaultLocale: string;
+}
+export interface NavigationConfiguration {
+    /**
+     * Document titles that open the folder they sit in, most preferred first.
+     * Matched case-insensitively against the title a reader sees, so the order
+     * prefix is not part of it.
+     */
+    readonly landingDocumentTitles: readonly string[];
+    /**
+     * Whether each folder gets a generated page listing its contents. Folder
+     * slugs are reserved either way, so turning this on or off moves no address.
+     */
+    readonly sectionIndexPages: boolean;
+}
+export interface SiteConfiguration {
+    readonly brand: BrandConfiguration;
+    readonly deployment: DeploymentConfiguration;
+    readonly home: HomeConfiguration;
+    readonly navigation: NavigationConfiguration;
+    readonly sync: SyncConfigurationDefaults;
+}
+export declare class SiteConfigurationError extends Error {
+    readonly name = "SiteConfigurationError";
+}
+export declare function parseSiteConfiguration(input: unknown): SiteConfiguration;
+export declare function loadSiteConfiguration(projectRoot: string): SiteConfiguration;