@ctcstack/ctcdocs-core 0.18.0 → 0.19.0

package/dist/corpus-structure.d.ts

@@ -19,6 +19,8 @@ export interface CorpusDocument {
      * on its new chain to be confirmed.
      */
     readonly publishedReaders?: '*' | readonly string[];
+    /** Set while such a move waits, as the manifest's `readersHeld` says. */
+    readonly readersHeld?: true;
     /** The permanent short ID (ADR-022), the title and Drive's modified time. */
     readonly shortId?: string;
     readonly title?: string;

package/dist/corpus-structure.js

@@ -74,6 +74,9 @@ export function parseCorpusStructure(manifest) {
             ...(title ? { title } : {}),
             ...(modified ? { modified } : {}),
             ...(source ? { source } : {}),
+            ...(typeof record.readersHeld === 'object' && record.readersHeld !== null
+                ? { readersHeld: true }
+                : {}),
             ...(published === '*' ||
                 (Array.isArray(published) &&
                     published.every((group) => typeof group === 'string'))

package/dist/project-layout.d.ts

@@ -26,6 +26,8 @@ export declare const PROJECT_LAYOUT: {
     readonly publicDirectory: "public";
     readonly robotsFile: "public/robots.txt";
     readonly headersFile: "public/_headers";
+    /** The pages a project writes by hand; generated ones sit beneath, apart. */
+    readonly documentsDirectory: "src/content/docs";
     /** Generated Markdown, one directory per Drive folder. */
     readonly generatedDocumentsDirectory: "src/content/docs/_generated";
     /** Original images, one directory per Google file identifier. */
@@ -68,6 +70,11 @@ export declare const PLATFORM_ROUTES: {
      * docs/ADR/024-content-health-page.md.
      */
     readonly contentHealth: "content-health";
+    /**
+     * Who may read each folder, for admins. See
+     * docs/ADR/045-an-access-review-page-shows-admins-who-may-read-each-folder.md.
+     */
+    readonly accessReview: "access-review";
 };
 /**
  * The platform's Workers, as a project's Wrangler configuration names them
@@ -100,6 +107,7 @@ export declare const ACCESS_CLASSES_ROUTE = "/_kb/classes";
 export declare const PLATFORM_ROUTE_HREFS: {
     readonly fullIndex: "/documents/";
     readonly contentHealth: "/content-health/";
+    readonly accessReview: "/access-review/";
 };
 export declare const RESERVED_SLUGS: readonly string[];
 /**

package/dist/project-layout.js

@@ -26,6 +26,8 @@ export const PROJECT_LAYOUT = {
     publicDirectory: 'public',
     robotsFile: 'public/robots.txt',
     headersFile: 'public/_headers',
+    /** The pages a project writes by hand; generated ones sit beneath, apart. */
+    documentsDirectory: 'src/content/docs',
     /** Generated Markdown, one directory per Drive folder. */
     generatedDocumentsDirectory: 'src/content/docs/_generated',
     /** Original images, one directory per Google file identifier. */
@@ -68,6 +70,11 @@ export const PLATFORM_ROUTES = {
      * docs/ADR/024-content-health-page.md.
      */
     contentHealth: 'content-health',
+    /**
+     * Who may read each folder, for admins. See
+     * docs/ADR/045-an-access-review-page-shows-admins-who-may-read-each-folder.md.
+     */
+    accessReview: 'access-review',
 };
 /**
  * The platform's Workers, as a project's Wrangler configuration names them
@@ -100,6 +107,7 @@ export const ACCESS_CLASSES_ROUTE = '/_kb/classes';
 export const PLATFORM_ROUTE_HREFS = {
     fullIndex: `/${PLATFORM_ROUTES.fullIndex}/`,
     contentHealth: `/${PLATFORM_ROUTES.contentHealth}/`,
+    accessReview: `/${PLATFORM_ROUTES.accessReview}/`,
 };
 /**
  * Top-level addresses the platform serves beside the corpus: the Worker's

package/dist/site-configuration.d.ts

@@ -33,6 +33,14 @@ export interface HomeConfiguration {
      * outgrown one page may prefer the home page to stay an entrance.
      */
     readonly corpusIndex: boolean;
+    /**
+     * The address of the hand-authored page the home page sends a newcomer to,
+     * as a slug: `about` for `src/content/docs/about.md`. The link reads that
+     * page's own title, so renaming the page renames the link. Without it the
+     * home page offers no such link: the platform does not know what a
+     * deployment calls its introduction, or whether it has one.
+     */
+    readonly start?: string;
 }
 /**
  * Who a deployment is for.

package/dist/site-configuration.js

@@ -121,6 +121,21 @@ function flag(source, key, path) {
 function optionalFlag(source, key, path, fallback) {
     return source[key] === undefined ? fallback : flag(source, key, path);
 }
+/**
+ * A page's address as Starlight derives it from a file under
+ * `src/content/docs`: lowercase segments joined by `/`, with no leading or
+ * trailing slash, so it is the same string the content collection knows.
+ */
+function optionalPageSlug(source, key, path) {
+    if (source[key] === undefined) {
+        return {};
+    }
+    const value = text(source, key, path);
+    if (!/^[a-z0-9][a-z0-9-]*(?:\/[a-z0-9][a-z0-9-]*)*$/u.test(value)) {
+        fail(path, 'must be a page address such as "about", without slashes at either end');
+    }
+    return { [key]: value };
+}
 /**
  * A list of distinct Unicode script names, as a `\p{Script=…}` property
  * escape spells them. Each name is proved by compiling that escape, so a typo
@@ -405,6 +420,7 @@ export function parseSiteConfiguration(input) {
             corpusIndex: optionalFlag(homeSource, 'corpusIndex', 'home.corpusIndex', true),
             lede: text(homeSource, 'lede', 'home.lede'),
             recentLimit: optionalCount(homeSource, 'recentLimit', 'home.recentLimit', 6),
+            ...optionalPageSlug(homeSource, 'start', 'home.start'),
         },
         navigation: {
             landingDocumentTitles: titleList(navigationSource, 'landingDocumentTitles', 'navigation.landingDocumentTitles'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctcstack/ctcdocs-core",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Configuration schema, project layout, generated-path allowlist and the published Markdown form shared by the CTCDocs platform packages.",
   "keywords": [
     "ctcdocs",

package/src/corpus-structure.ts

@@ -33,6 +33,8 @@ export interface CorpusDocument {
    * on its new chain to be confirmed.
    */
   readonly publishedReaders?: '*' | readonly string[];
+  /** Set while such a move waits, as the manifest's `readersHeld` says. */
+  readonly readersHeld?: true;
   /** The permanent short ID (ADR-022), the title and Drive's modified time. */
   readonly shortId?: string;
   readonly title?: string;
@@ -125,6 +127,9 @@ export function parseCorpusStructure(manifest: unknown): CorpusStructure {
       ...(title ? { title } : {}),
       ...(modified ? { modified } : {}),
       ...(source ? { source } : {}),
+      ...(typeof record.readersHeld === 'object' && record.readersHeld !== null
+        ? { readersHeld: true as const }
+        : {}),
       ...(published === '*' ||
       (Array.isArray(published) &&
         published.every((group) => typeof group === 'string'))

package/src/project-layout.ts

@@ -26,6 +26,8 @@ export const PROJECT_LAYOUT = {
   publicDirectory: 'public',
   robotsFile: 'public/robots.txt',
   headersFile: 'public/_headers',
+  /** The pages a project writes by hand; generated ones sit beneath, apart. */
+  documentsDirectory: 'src/content/docs',
   /** Generated Markdown, one directory per Drive folder. */
   generatedDocumentsDirectory: 'src/content/docs/_generated',
   /** Original images, one directory per Google file identifier. */
@@ -69,6 +71,11 @@ export const PLATFORM_ROUTES = {
    * docs/ADR/024-content-health-page.md.
    */
   contentHealth: 'content-health',
+  /**
+   * Who may read each folder, for admins. See
+   * docs/ADR/045-an-access-review-page-shows-admins-who-may-read-each-folder.md.
+   */
+  accessReview: 'access-review',
 } as const;
 
 /**
@@ -104,6 +111,7 @@ export const ACCESS_CLASSES_ROUTE = '/_kb/classes';
 export const PLATFORM_ROUTE_HREFS = {
   fullIndex: `/${PLATFORM_ROUTES.fullIndex}/`,
   contentHealth: `/${PLATFORM_ROUTES.contentHealth}/`,
+  accessReview: `/${PLATFORM_ROUTES.accessReview}/`,
 } as const;
 
 /**

package/src/site-configuration.ts

@@ -55,6 +55,14 @@ export interface HomeConfiguration {
    * outgrown one page may prefer the home page to stay an entrance.
    */
   readonly corpusIndex: boolean;
+  /**
+   * The address of the hand-authored page the home page sends a newcomer to,
+   * as a slug: `about` for `src/content/docs/about.md`. The link reads that
+   * page's own title, so renaming the page renames the link. Without it the
+   * home page offers no such link: the platform does not know what a
+   * deployment calls its introduction, or whether it has one.
+   */
+  readonly start?: string;
 }
 
 /**
@@ -380,6 +388,29 @@ function optionalFlag(
   return source[key] === undefined ? fallback : flag(source, key, path);
 }
 
+/**
+ * A page's address as Starlight derives it from a file under
+ * `src/content/docs`: lowercase segments joined by `/`, with no leading or
+ * trailing slash, so it is the same string the content collection knows.
+ */
+function optionalPageSlug(
+  source: Record<string, unknown>,
+  key: string,
+  path: string,
+): Record<string, string> {
+  if (source[key] === undefined) {
+    return {};
+  }
+  const value = text(source, key, path);
+  if (!/^[a-z0-9][a-z0-9-]*(?:\/[a-z0-9][a-z0-9-]*)*$/u.test(value)) {
+    fail(
+      path,
+      'must be a page address such as "about", without slashes at either end',
+    );
+  }
+  return { [key]: value };
+}
+
 /**
  * A list of distinct Unicode script names, as a `\p{Script=…}` property
  * escape spells them. Each name is proved by compiling that escape, so a typo
@@ -822,6 +853,7 @@ export function parseSiteConfiguration(input: unknown): SiteConfiguration {
         'home.recentLimit',
         6,
       ),
+      ...optionalPageSlug(homeSource, 'start', 'home.start'),
     },
     navigation: {
       landingDocumentTitles: titleList(