create-ailk 0.15.0 → 0.16.0

package/dist/site-manifest.d.ts

@@ -13,6 +13,11 @@ export interface PlanSiteManifestOptions {
     level: Level | undefined;
     /** The scaffold's topology (#7426 D10). */
     topology: Topology;
+    /**
+     * `"hub"` on a spoke that signs in through its hub (#7894 D1); absent
+     * otherwise, so every other manifest is byte-identical to before.
+     */
+    signIn?: "hub";
     /** The create-ailk version that wrote the scaffold (`CREATE_AILK_VERSION`). */
     patternVersion: string;
     siteTemplatesDir: string;
@@ -30,3 +35,41 @@ export interface PlanSiteManifestOptions {
  *   silently mis-record the site.
  */
 export declare function planSiteManifest(opts: PlanSiteManifestOptions): string;
+/** The two fields `create-ailk adopt` records (#7875). */
+export interface TopologyRecord {
+    topology: Topology;
+    patternVersion: string;
+}
+/**
+ * `text` with `topology` and `patternVersion` inserted directly after the
+ * last of `requires`, `modules`, `level` the file records — the position
+ * `planSiteManifest` gives them (#7875 D3). Every other byte is the input's.
+ *
+ * @throws AddModuleRefusedError when the file already records either field,
+ *   records none of the anchor keys, records one more than once at the top
+ *   level, or the result does not read back the two values exactly.
+ */
+export declare function planTopologyRecord(text: string, record: TopologyRecord, label: string): string;
+export interface PlanAdoptedSiteManifestOptions extends TopologyRecord {
+    targetDir: string;
+    /** The template the site was built from — a `SHAPE_STARTERS` or `resolveTemplate` name. */
+    template: string;
+    /** The site's module set. */
+    modules: readonly ModuleName[];
+    siteTemplatesDir: string;
+    templatesDir: string;
+    markers: MarkerMap;
+}
+/**
+ * The manifest for a site that has none (#7875 D4): a seed naming the
+ * template, its `requires` and no rows, parsed the way `readSiteRoster`
+ * reads a manifest, then `planSiteManifest` over it — so module rows, sample
+ * rows and a code-route row per page route on disk arrive exactly as a
+ * scaffold's would. No `level` (it comes only from a licence key), and none
+ * of the template's `shape`, `design`, `categories`, `layout` or `theme`:
+ * they would claim a look the site may not wear.
+ *
+ * @throws AddModuleRefusedError when the template is undeclared, or as
+ *   `planSiteManifest` does.
+ */
+export declare function planAdoptedSiteManifest(opts: PlanAdoptedSiteManifestOptions): string;

package/dist/site-manifest.js

@@ -19,6 +19,9 @@
  *     and the create-ailk version that wrote the files, on every scaffold.
  *     A site with no `topology` predates the option and reads as a hub
  *     (`topology.ts` `readSiteTopology`);
+ *   - `signIn` (#7894 D1) — `"hub"` on a spoke that signs in through its
+ *     hub, written after `topology` on such a spoke only; absent reads as
+ *     `"off"` (`topology.ts` `readSpokeShape`);
  *   - a row for every route present on disk — each module's contributed rows
  *     through `planRosterAppend` (add-module's own append), the sample pages
  *     a module's bundle installs (`sampleRows`), and a code-route row for any
@@ -35,7 +38,7 @@ import { join, relative, sep } from "node:path";
 import { isDeepStrictEqual } from "node:util";
 import { AddModuleRefusedError } from "./add-module-core.js";
 import { MODULE_SLICES, normalizeModules } from "./module-architecture.js";
-import { moduleRosterRows, planRosterAppend, } from "./site-roster.js";
+import { SITE_ROSTER_PATH, moduleRosterRows, parseSiteRoster, planRosterAppend, resolveRosterTemplate, } from "./site-roster.js";
 import { TEMPLATE_MANIFESTS, rosterDeclares, templateTreeDir, } from "./template-manifest.js";
 /** Prettier's default print width — the generator formats the manifest with it. */
 const PRINT_WIDTH = 80;
@@ -66,7 +69,13 @@ const CODE_ROUTE_ROW = {
  */
 export function planSiteManifest(opts) {
     const { roster } = opts;
-    for (const key of ["modules", "level", "topology", "patternVersion"]) {
+    for (const key of [
+        "modules",
+        "level",
+        "topology",
+        "signIn",
+        "patternVersion",
+    ]) {
         if (key in roster.doc) {
             throw new AddModuleRefusedError(`${roster.path} already records "${key}"`);
         }
@@ -89,6 +98,90 @@ export function planSiteManifest(opts) {
     const withRows = appendRows(appended, extra, roster);
     return insertRecord(withRows, opts, roster.path);
 }
+/** The top-level keys `planSiteManifest` writes before the topology record, in order. */
+const RECORD_ANCHORS = ["requires", "modules", "level"];
+/**
+ * `text` with `topology` and `patternVersion` inserted directly after the
+ * last of `requires`, `modules`, `level` the file records — the position
+ * `planSiteManifest` gives them (#7875 D3). Every other byte is the input's.
+ *
+ * @throws AddModuleRefusedError when the file already records either field,
+ *   records none of the anchor keys, records one more than once at the top
+ *   level, or the result does not read back the two values exactly.
+ */
+export function planTopologyRecord(text, record, label) {
+    const doc = JSON.parse(text);
+    for (const key of ["topology", "patternVersion"]) {
+        if (key in doc) {
+            throw new AddModuleRefusedError(`${label} already records "${key}"`);
+        }
+    }
+    let end = -1;
+    for (const key of RECORD_ANCHORS) {
+        if (!(key in doc))
+            continue;
+        const anchor = `\n  ${JSON.stringify(key)}: `;
+        const at = text.indexOf(anchor);
+        if (at === -1 || text.indexOf(anchor, at + 1) !== -1) {
+            throw new AddModuleRefusedError(`${label} has no single top-level "${key}" key to record the topology beside`);
+        }
+        const start = at + anchor.length;
+        const close = text[start] === "[" ? "]" : '"';
+        end = Math.max(end, text.indexOf(close, start + 1) + 1);
+    }
+    if (end === -1) {
+        throw new AddModuleRefusedError(`${label} has no top-level "requires" key to record the topology beside`);
+    }
+    const next = text.slice(0, end) +
+        `,\n  "topology": ${JSON.stringify(record.topology)}` +
+        `,\n  "patternVersion": ${JSON.stringify(record.patternVersion)}` +
+        text.slice(end);
+    let after;
+    try {
+        after = JSON.parse(next);
+    }
+    catch {
+        after = {};
+    }
+    if (after["topology"] !== record.topology ||
+        after["patternVersion"] !== record.patternVersion) {
+        throw new AddModuleRefusedError(`${label}: the topology could not be recorded after its last top-level key`);
+    }
+    return next;
+}
+/**
+ * The manifest for a site that has none (#7875 D4): a seed naming the
+ * template, its `requires` and no rows, parsed the way `readSiteRoster`
+ * reads a manifest, then `planSiteManifest` over it — so module rows, sample
+ * rows and a code-route row per page route on disk arrive exactly as a
+ * scaffold's would. No `level` (it comes only from a licence key), and none
+ * of the template's `shape`, `design`, `categories`, `layout` or `theme`:
+ * they would claim a look the site may not wear.
+ *
+ * @throws AddModuleRefusedError when the template is undeclared, or as
+ *   `planSiteManifest` does.
+ */
+export function planAdoptedSiteManifest(opts) {
+    let requires;
+    try {
+        requires = resolveRosterTemplate(opts.template).requires;
+    }
+    catch (err) {
+        throw new AddModuleRefusedError(`"${opts.template}" names no declared template (${err.message})`);
+    }
+    const seed = `${renderJson({ template: opts.template, requires: [...requires], rows: [] }, 0)}\n`;
+    return planSiteManifest({
+        targetDir: opts.targetDir,
+        roster: parseSiteRoster(seed, SITE_ROSTER_PATH),
+        modules: opts.modules,
+        level: undefined,
+        topology: opts.topology,
+        patternVersion: opts.patternVersion,
+        siteTemplatesDir: opts.siteTemplatesDir,
+        templatesDir: opts.templatesDir,
+        markers: opts.markers,
+    });
+}
 /**
  * The rows for the sample pages a module's bundle installs through its
  * `installMap` (`signal-collectors`' /projects family) that no row names yet:
@@ -244,7 +337,7 @@ function appendRows(text, rows, roster) {
  * `patternVersion` inserted after the top-level `requires`.
  */
 function insertRecord(text, opts, label) {
-    const { modules, level, topology, patternVersion } = opts;
+    const { modules, level, topology, signIn, patternVersion } = opts;
     const anchor = '\n  "requires": ';
     const at = text.indexOf(anchor);
     if (at === -1 || text.indexOf(anchor, at + 1) !== -1) {
@@ -255,12 +348,14 @@ function insertRecord(text, opts, label) {
     const record = `,\n  ${name}${renderJson([...modules], 2, name.length, 1)}` +
         (level !== undefined ? `,\n  "level": ${JSON.stringify(level)}` : "") +
         `,\n  "topology": ${JSON.stringify(topology)}` +
+        (signIn !== undefined ? `,\n  "signIn": ${JSON.stringify(signIn)}` : "") +
         `,\n  "patternVersion": ${JSON.stringify(patternVersion)}`;
     const next = text.slice(0, end) + record + text.slice(end);
     const doc = JSON.parse(next);
     if (!isDeepStrictEqual(doc["modules"], [...modules]) ||
         doc["level"] !== level ||
         doc["topology"] !== topology ||
+        doc["signIn"] !== signIn ||
         doc["patternVersion"] !== patternVersion) {
         throw new AddModuleRefusedError(`${label}: the module set could not be recorded beside "requires"`);
     }

package/dist/site-roster.d.ts

@@ -58,6 +58,19 @@ export interface ModuleRosterRow {
  * not declare is refused: guessing would silently mis-roster the site.
  */
 export declare function readSiteRoster(targetDir: string): SiteRoster | undefined;
+/**
+ * The roster `text` holds, read as `readSiteRoster` reads the file at the
+ * site-relative `path` (#7875 D10) — the one parse, so a manifest `adopt`
+ * builds goes through the same template resolution a read one does.
+ */
+export declare function parseSiteRoster(text: string, path: string): SiteRoster;
+/**
+ * The registry entry a manifest's `template` names. #6757 D6 — a bare-shape
+ * starter's name (the shape itself) resolves through SHAPE_STARTERS first;
+ * `resolveTemplate` alone never sees one (NFR-3).
+ * @throws Error from `resolveTemplate` when the name is undeclared.
+ */
+export declare function resolveRosterTemplate(name: string): TemplateManifest;
 /** What `planSiteManifestDesign` writes when it rewrites the manifest. */
 export interface SiteManifestDesignNext {
     design: string;

package/dist/site-roster.js

@@ -11,6 +11,7 @@
  * does (#6646). This module owns every read and write of that file:
  *
  *   - `readSiteRoster` — the file, or `undefined` for a template-less site;
+ *     `parseSiteRoster` is its parse of given text (#7875 D10);
  *   - `moduleRosterRows` — a module's rows, read from the generator's own
  *     output in the shipped template manifests (never re-derived: the
  *     derivation needs a YAML parser the package does not ship, and would be
@@ -167,22 +168,35 @@ export function readSiteRoster(targetDir) {
     const path = [SITE_ROSTER_PATH, LEGACY_SITE_ROSTER_PATH].find((name) => existsSync(join(targetDir, name)));
     if (path === undefined)
         return undefined;
-    const file = parseRosterFile(readFileSync(join(targetDir, path), "utf8"), path);
-    const name = String(file.doc["template"]);
+    return parseSiteRoster(readFileSync(join(targetDir, path), "utf8"), path);
+}
+/**
+ * The roster `text` holds, read as `readSiteRoster` reads the file at the
+ * site-relative `path` (#7875 D10) — the one parse, so a manifest `adopt`
+ * builds goes through the same template resolution a read one does.
+ */
+export function parseSiteRoster(text, path) {
+    const file = parseRosterFile(text, path);
     let template;
     try {
-        // #6757 D6 — a bare-shape starter's name (the shape itself) resolves
-        // through SHAPE_STARTERS first; `resolveTemplate` alone never sees one
-        // (NFR-3).
-        template = Object.prototype.hasOwnProperty.call(SHAPE_STARTERS, name)
-            ? SHAPE_STARTERS[name]
-            : resolveTemplate(name);
+        template = resolveRosterTemplate(String(file.doc["template"]));
     }
     catch (err) {
         throw new AddModuleRefusedError(`${path} names no declared template (${err.message}), so the page roster is unknown`);
     }
     return { ...file, template, path };
 }
+/**
+ * The registry entry a manifest's `template` names. #6757 D6 — a bare-shape
+ * starter's name (the shape itself) resolves through SHAPE_STARTERS first;
+ * `resolveTemplate` alone never sees one (NFR-3).
+ * @throws Error from `resolveTemplate` when the name is undeclared.
+ */
+export function resolveRosterTemplate(name) {
+    return Object.prototype.hasOwnProperty.call(SHAPE_STARTERS, name)
+        ? SHAPE_STARTERS[name]
+        : resolveTemplate(name);
+}
 /** `value`, rendered the way prettier prints an object-only JSON value nested one level under the manifest's root object. */
 function renderManifestValue(value) {
     return JSON.stringify(value, null, 2)

package/dist/spoke-checkout.d.ts

@@ -0,0 +1,42 @@
+import type { EnvCatalogEntry, PlanEnvRowsOptions } from "./lib/declared-env.js";
+import { type InstallReportRow } from "./lib/extract-module-bundle.js";
+import { type WorkspaceVersionMap } from "./substitute.js";
+/** The checkout package a spoke's two route files import. */
+export declare const SPOKE_CHECKOUT_PACKAGE = "@working-theory/spoke-checkout";
+/** The site's checkout data — written once, the site's from then on. */
+export declare const SPOKE_CHECKOUT_CONFIG_PATH = "apps/web/lib/checkout-config.ts";
+/** The two return pages: Stripe's success URL and every refused buy's target. */
+export declare const SPOKE_CHECKOUT_PAGE_FILES: readonly string[];
+/** The variables a commerce spoke depends on (D9). The package reads three of them. */
+export declare const SPOKE_CHECKOUT_ENV_CATALOG: Readonly<Record<string, EnvCatalogEntry>>;
+/** The names a commerce spoke declares although only the package reads them (D9). */
+export declare const SPOKE_CHECKOUT_DECLARED_ENV: readonly string[];
+/**
+ * The catalog (and declared names) a spoke's `appendEnvRows` call passes: a
+ * commerce spoke adds the checkout's four rows (D9). `ENV_CATALOG` itself is
+ * unchanged — its test fails on an entry the monorepo's apps never read.
+ */
+export declare function spokeEnvRowOptions(commerce: boolean): Pick<PlanEnvRowsOptions, "catalog" | "declare">;
+/**
+ * The site stamp for a project name (D6): lower-cased, every run outside
+ * `a-z0-9` collapsed to `-`, trimmed, cut to 40. A name that leaves nothing
+ * usable — or `default`, which is also an unset hub's own stamp — gets
+ * `site-` and the first 8 hex characters of its SHA-256. Never `AILK_SITE_ID`.
+ */
+export declare function spokeCheckoutSite(projectName: string): string;
+/**
+ * The slice for `site`, in order: the two route files, the config, the two
+ * pages (D3). Throws `TopologyError` for an invalid stamp (SEC-7838-10).
+ */
+export declare function renderSpokeCheckoutFiles(site: string): [string, string][];
+/**
+ * Write the slice into `targetDir` (D3). A file that already exists is left
+ * byte-for-byte and reported `skipped` — the config is the site's once
+ * written. Adds the package to `apps/web/package.json` only when absent.
+ * Every refusal (an invalid stamp, a version map without the package, a
+ * missing or malformed `apps/web/package.json`) throws before the first write.
+ */
+export declare function writeSpokeCheckoutSlice(targetDir: string, opts: {
+    site: string;
+    versions: WorkspaceVersionMap;
+}): InstallReportRow[];