@forumulate/cli 0.3.5 → 0.4.0

package/dist/publish/rewrite.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rewriteLinks = rewriteLinks;
+exports.rewriteAssets = rewriteAssets;
+exports.rewriteValue = rewriteValue;
+const node_path_1 = require("node:path");
+/**
+ * What changes between the file on disk and the text the API is sent.
+ *
+ * Only addresses. The prose — and with it our Markdown directive dialect
+ * (`:::note`, `{% tabs %}`, admonitions, components) — goes through as
+ * written, because the importer is the product's own converter and a second
+ * converter here would be a second, drifting opinion about the same syntax.
+ * Every customer publisher that grew its own block converter (two of the four)
+ * ended up maintaining it against ours.
+ */
+/** Characters with meaning in a regular expression, escaped. */
+const esc = (s) => s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+/**
+ * `[text](../setup/install.md#flags)` → `[text](./install#flags)`.
+ *
+ * The importer rewrites links between files it is sent in the SAME call, and
+ * the publisher only sends what changed — so a changed page linking an
+ * unchanged one would keep a link to a `.md` file that does not exist on the
+ * web. The CLI knows every file's slug, so it rewrites every link it can
+ * resolve itself, in the importer's own form (page-relative `./slug`: the same
+ * page is reached at `/slug`, `/space/slug` and `/p/org/space/slug`, and only a
+ * relative link is right at all three).
+ */
+function rewriteLinks(source, file, slugByFile) {
+    const lower = new Map([...slugByFile].map(([k, v]) => [k.toLowerCase(), v]));
+    const target = (ref) => {
+        const m = /^(?!\w[\w+.-]*:|\/|#)([^?#\s]+\.(?:md|mdx|markdown))((?:[?#][^\s]*)?)$/i.exec(ref);
+        if (!m)
+            return null;
+        let path;
+        try {
+            path = node_path_1.posix.normalize(node_path_1.posix.join(node_path_1.posix.dirname(file), decodeURI(m[1])));
+        }
+        catch {
+            return null;
+        }
+        const slug = lower.get(path.toLowerCase());
+        return slug ? `./${slug}${m[2] ?? ''}` : null;
+    };
+    let out = source.replace(/(\]\(\s*)(<[^>]+>|[^)\s]+)/g, (all, open, ref) => {
+        const t = target(ref.replace(/^<|>$/g, ''));
+        return t ? `${open}${t}` : all;
+    });
+    out = out.replace(/(\bhref\s*=\s*["'])([^"']+)(["'])/g, (all, a, ref, b) => {
+        const t = target(ref);
+        return t ? `${a}${t}${b}` : all;
+    });
+    return out;
+}
+/**
+ * Local images and files → the uploaded asset's URL, wherever the file names
+ * them: a Markdown image or link, an HTML `src`/`href`, a front matter value.
+ */
+function rewriteAssets(source, urlByRef) {
+    let out = source;
+    for (const [ref, url] of urlByRef) {
+        const r = esc(ref);
+        out = out
+            .replace(new RegExp(`(\\]\\(\\s*<?)${r}(>?)`, 'g'), `$1${url}$2`)
+            .replace(new RegExp(`(\\b(?:src|href|poster)\\s*=\\s*["'])${r}(["'])`, 'g'), `$1${url}$2`)
+            .replace(new RegExp(`(^|\\n)([ \\t]*[\\w-]+\\s*:\\s*["']?)${r}(["']?[ \\t]*(?=\\n|$))`, 'g'), `$1$2${url}$3`)
+            .replace(new RegExp(`(\\n[ \\t]*-\\s*["']?)${r}(["']?[ \\t]*(?=\\n|$))`, 'g'), `$1${url}$2`);
+    }
+    return out;
+}
+/** The same substitution over a metadata patch (values that were local paths). */
+function rewriteValue(value, urlByRef) {
+    if (typeof value === 'string')
+        return (urlByRef.get(value.trim()) ?? value);
+    if (Array.isArray(value))
+        return value.map((v) => rewriteValue(v, urlByRef));
+    if (value && typeof value === 'object')
+        return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, rewriteValue(v, urlByRef)]));
+    return value;
+}
+//# sourceMappingURL=rewrite.js.map

package/dist/publish/rewrite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rewrite.js","sourceRoot":"","sources":["../../src/publish/rewrite.ts"],"names":[],"mappings":";;AA2BA,oCA8BC;AAMD,sCAcC;AAGD,oCAQC;AAxFD,yCAAkC;AAElC;;;;;;;;;GASG;AAEH,gEAAgE;AAChE,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAEpE;;;;;;;;;;GAUG;AACH,SAAgB,YAAY,CAC1B,MAAc,EACd,IAAY,EACZ,UAA+B;IAE/B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7E,MAAM,MAAM,GAAG,CAAC,GAAW,EAAiB,EAAE;QAC5C,MAAM,CAAC,GAAG,yEAAyE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9F,IAAI,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACpB,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,iBAAK,CAAC,SAAS,CAAC,iBAAK,CAAC,IAAI,CAAC,iBAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAChD,CAAC,CAAC;IACF,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,6BAA6B,EAAE,CAAC,GAAG,EAAE,IAAY,EAAE,GAAW,EAAE,EAAE;QACzF,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5C,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,GAAG,GAAG,GAAG,CAAC,OAAO,CACf,oCAAoC,EACpC,CAAC,GAAG,EAAE,CAAS,EAAE,GAAW,EAAE,CAAS,EAAE,EAAE;QACzC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACtB,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IAClC,CAAC,CACF,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,MAAc,EAAE,QAA6B;IACzE,IAAI,GAAG,GAAG,MAAM,CAAC;IACjB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,QAAQ,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,GAAG,GAAG,GAAG;aACN,OAAO,CAAC,IAAI,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;aAChE,OAAO,CAAC,IAAI,MAAM,CAAC,wCAAwC,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;aACzF,OAAO,CACN,IAAI,MAAM,CAAC,wCAAwC,CAAC,yBAAyB,EAAE,GAAG,CAAC,EACnF,OAAO,GAAG,IAAI,CACf;aACA,OAAO,CAAC,IAAI,MAAM,CAAC,yBAAyB,CAAC,yBAAyB,EAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;IACjG,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kFAAkF;AAClF,SAAgB,YAAY,CAAI,KAAQ,EAAE,QAA6B;IACrE,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,CAAM,CAAC;IACjF,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAM,CAAC;IAClF,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QACpC,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CACjE,CAAC;IACT,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/publish/scan.d.ts

@@ -0,0 +1,25 @@
+import type { LocalSpace, SpaceSpec } from './types';
+export declare const MANIFEST_NAMES: string[];
+/** The product's slug rule (packages/shared `slugify`), mirrored: this package ships alone. */
+export declare function slugify(input: string, fallback?: string): string;
+/**
+ * The product's TAG rule (apps/api `normalizeTag`), mirrored for the same reason
+ * as `slugify`. Used to compare a front-matter tag list with the stored one: an
+ * ASCII-only fold here turned every Japanese or Cyrillic tag into `-`, so two
+ * different non-Latin tag lists compared equal and the update was skipped.
+ */
+export declare function tagKey(raw: string): string;
+/** `02-getting-started` → `Getting Started`. */
+export declare function titleize(name: string): string;
+export interface ScanResult extends LocalSpace {
+    /** Per file (relative to the space folder): reference as written → absolute asset path. */
+    refs: Map<string, Map<string, string>>;
+    /** Every Markdown file of the space (relative to the space folder) → its slug. */
+    slugByFile: Map<string, string>;
+}
+/** Read one space folder. `kind` decides whether its files are pages or posts. */
+export declare function scanSpace(root: string, spec: SpaceSpec, kind: 'docs' | 'posts', fieldKeys: string[]): ScanResult;
+/** Every relative path → posix, for comparing with `importName`s. */
+export declare const toPosix: (p: string) => string;
+export declare const extOf: (p: string) => string;
+//# sourceMappingURL=scan.d.ts.map

package/dist/publish/scan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan.d.ts","sourceRoot":"","sources":["../../src/publish/scan.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAA8B,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAejF,eAAO,MAAM,cAAc,UAA2D,CAAC;AAKvF,+FAA+F;AAC/F,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,SAAS,GAAG,MAAM,CAahE;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAc1C;AAED,gDAAgD;AAChD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7C;AAwED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,2FAA2F;IAC3F,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACvC,kFAAkF;IAClF,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,SAAS,EACf,IAAI,EAAE,MAAM,GAAG,OAAO,EACtB,SAAS,EAAE,MAAM,EAAE,GAClB,UAAU,CAgCZ;AAqPD,qEAAqE;AACrE,eAAO,MAAM,OAAO,GAAI,GAAG,MAAM,WAA2B,CAAC;AAC7D,eAAO,MAAM,KAAK,GAAI,GAAG,MAAM,WAA6B,CAAC"}

package/dist/publish/scan.js

@@ -0,0 +1,351 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extOf = exports.toPosix = exports.MANIFEST_NAMES = void 0;
+exports.slugify = slugify;
+exports.tagKey = tagKey;
+exports.titleize = titleize;
+exports.scanSpace = scanSpace;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const yaml_1 = require("yaml");
+const frontmatter_1 = require("./frontmatter");
+/**
+ * A folder on disk, read into what it would publish.
+ *
+ * Docs: one top-level folder per collection, files at the root in the root
+ * collection, nested folders as parent pages (the folder's `index.md` or
+ * `README.md` is the parent; a folder without one gets a title-only stub so its
+ * children still have somewhere to hang). Everything else — blog, changelog,
+ * any type whose pieces are posts — is a flat set of posts, folders or not.
+ */
+const MD = /\.(md|mdx|markdown)$/i;
+/** What a reference may point at to be uploaded rather than linked. */
+const ASSET = /\.(png|jpe?g|gif|webp|svg|avif|ico|pdf|mp4|webm|mp3|zip)$/i;
+exports.MANIFEST_NAMES = ['forumulate.yaml', 'forumulate.yml', 'forumulate.json'];
+const NUMERIC = /^(\d+)[-_. ]+/;
+const DATED = /^(\d{4}-\d{2}-\d{2})[-_]/;
+const BIG = Number.MAX_SAFE_INTEGER;
+/** The product's slug rule (packages/shared `slugify`), mirrored: this package ships alone. */
+function slugify(input, fallback = 'page') {
+    return (input
+        .normalize('NFC')
+        .toLowerCase()
+        .normalize('NFD')
+        .replace(/[̀-ͯ]/g, '')
+        .normalize('NFC')
+        .replace(/[^\p{Letter}\p{Number}]+/gu, '-')
+        .replace(/^-+|-+$/g, '')
+        .slice(0, 70)
+        .replace(/-+$/, '') || fallback);
+}
+/**
+ * The product's TAG rule (apps/api `normalizeTag`), mirrored for the same reason
+ * as `slugify`. Used to compare a front-matter tag list with the stored one: an
+ * ASCII-only fold here turned every Japanese or Cyrillic tag into `-`, so two
+ * different non-Latin tag lists compared equal and the update was skipped.
+ */
+function tagKey(raw) {
+    const t = String(raw ?? '')
+        .normalize('NFC')
+        .toLowerCase()
+        .normalize('NFD')
+        .replace(/[\u0300-\u036f]/g, '')
+        .normalize('NFC')
+        .replace(/[^\p{Letter}\p{Number}+#.-]+/gu, '-')
+        .replace(/^[-#]+/, '')
+        .replace(/^\.+(?![\p{Letter}\p{Number}])/u, '')
+        .replace(/^[-#]+/, '')
+        .replace(/[-.]+$/, '');
+    if (!/[\p{Letter}\p{Number}]/u.test(t))
+        return '';
+    return t.slice(0, 60).replace(/[-.]+$/, '');
+}
+/** `02-getting-started` → `Getting Started`. */
+function titleize(name) {
+    const bare = name.replace(NUMERIC, '').replace(/[-_]+/g, ' ').trim();
+    return bare.replace(/\b\p{Letter}/gu, (c) => c.toUpperCase()) || name;
+}
+const isIndex = (file) => /^(index|readme)\.(md|mdx|markdown)$/i.test((0, node_path_1.basename)(file));
+const skipEntry = (name) => name.startsWith('.') ||
+    name.startsWith('_') ||
+    name === 'node_modules' ||
+    exports.MANIFEST_NAMES.includes(name);
+/** `[n, name]` from a numeric prefix, or "no position" sorted by name. */
+function prefixOrder(name) {
+    const m = NUMERIC.exec(name);
+    return [m ? Number(m[1]) : BIG, name.replace(NUMERIC, '').toLowerCase()];
+}
+function hasMarkdown(dir) {
+    for (const e of (0, node_fs_1.readdirSync)(dir)) {
+        if (skipEntry(e))
+            continue;
+        const p = (0, node_path_1.join)(dir, e);
+        if ((0, node_fs_1.statSync)(p).isDirectory() ? hasMarkdown(p) : MD.test(e))
+            return true;
+    }
+    return false;
+}
+/** `_collection.yml` / `.yaml` / `.json` beside a collection's files. */
+function folderMeta(dir) {
+    for (const n of ['_collection.yml', '_collection.yaml', '_collection.json']) {
+        const p = (0, node_path_1.join)(dir, n);
+        if ((0, node_fs_1.existsSync)(p))
+            return ((0, yaml_1.parse)((0, node_fs_1.readFileSync)(p, 'utf8')) ?? {});
+    }
+    return {};
+}
+/** The title a page will get: front matter, else the leading `# heading` (the importer's rule). */
+function titleOf(front, body, fallback) {
+    if (typeof front.title === 'string' && front.title.trim())
+        return front.title.trim();
+    const first = body.split(/\r?\n/).find((l) => l.trim());
+    const h1 = first && /^#\s+(.+?)\s*#*\s*$/.exec(first);
+    // A title is stored as plain text: the importer keeps the heading's words and
+    // drops its marks, so `` `required` `` comes back as `required`.
+    const plain = h1?.[1]
+        ?.replace(/!?\[([^\]]*)\]\([^)]*\)/g, '$1')
+        .replace(/[`*_~]/g, '')
+        .trim();
+    return plain || fallback;
+}
+/** Local files a document points at — images, PDFs — resolved from its own folder. */
+function assetRefs(text, fileDir, front) {
+    const refs = new Map();
+    const consider = (ref) => {
+        const clean = ref.trim().replace(/^<|>$/g, '').split(/[?#]/)[0];
+        if (!clean || /^[a-z][a-z0-9+.-]*:/i.test(clean) || clean.startsWith('/') || !ASSET.test(clean))
+            return;
+        const abs = (0, node_path_1.resolve)(fileDir, decodeURI(clean));
+        if ((0, node_fs_1.existsSync)(abs) && (0, node_fs_1.statSync)(abs).isFile())
+            refs.set(ref.trim(), abs);
+    };
+    for (const m of text.matchAll(/!?\[[^\]]*\]\(\s*(<[^>]+>|[^)\s]+)/g))
+        consider(m[1]);
+    for (const m of text.matchAll(/\b(?:src|href|poster)\s*=\s*["']([^"']+)["']/g))
+        consider(m[1]);
+    const walk = (v) => {
+        if (typeof v === 'string')
+            consider(v);
+        else if (Array.isArray(v))
+            v.forEach(walk);
+        else if (v && typeof v === 'object')
+            Object.values(v).forEach(walk);
+    };
+    walk(front);
+    return refs;
+}
+/** Read one space folder. `kind` decides whether its files are pages or posts. */
+function scanSpace(root, spec, kind, fieldKeys) {
+    const absDir = (0, node_path_1.resolve)(root, spec.path || '.');
+    const out = {
+        dir: spec.path || '',
+        absDir,
+        collections: [],
+        posts: [],
+        assets: new Set(),
+        warnings: [],
+        refs: new Map(),
+        slugByFile: new Map(),
+    };
+    if (!(0, node_fs_1.existsSync)(absDir) || !(0, node_fs_1.statSync)(absDir).isDirectory()) {
+        out.warnings.push(`${absDir} is not a folder`);
+        return out;
+    }
+    const read = (abs) => {
+        const text = (0, node_fs_1.readFileSync)(abs, 'utf8');
+        const rel = (0, node_path_1.relative)(absDir, abs).split(node_path_1.sep).join('/');
+        try {
+            const { data, body } = (0, frontmatter_1.splitFront)(text);
+            const refs = assetRefs(text, (0, node_path_1.dirname)(abs), data);
+            if (refs.size)
+                out.refs.set(rel, refs);
+            for (const a of refs.values())
+                out.assets.add(a);
+            return { rel, text, data, body };
+        }
+        catch (e) {
+            throw new Error(`${rel}: ${e.message}`);
+        }
+    };
+    if (kind === 'posts')
+        scanPosts(absDir, out, read);
+    else
+        scanDocs(absDir, spec, out, read, fieldKeys);
+    return out;
+}
+function scanPosts(absDir, out, read) {
+    const walk = (dir) => {
+        for (const e of (0, node_fs_1.readdirSync)(dir).sort()) {
+            if (skipEntry(e))
+                continue;
+            const abs = (0, node_path_1.join)(dir, e);
+            if ((0, node_fs_1.statSync)(abs).isDirectory()) {
+                walk(abs);
+                continue;
+            }
+            if (!MD.test(e))
+                continue;
+            // A README at the top of a blog folder is a note about the folder.
+            if (dir === absDir && /^readme\./i.test(e)) {
+                out.warnings.push(`${e}: skipped — a README at the top of a posts folder is a note, not a post`);
+                continue;
+            }
+            const f = read(abs);
+            if ((0, frontmatter_1.isDraft)(f.data)) {
+                out.warnings.push(`${f.rel}: draft — left out`);
+                continue;
+            }
+            const stem = e.replace(MD, '');
+            const dated = DATED.exec(stem);
+            const front = { ...f.data };
+            if (dated && front.publishedAt === undefined && front.date === undefined)
+                front.publishedAt = dated[1];
+            if (front.date !== undefined && front.publishedAt === undefined)
+                front.publishedAt = front.date;
+            const slug = typeof f.data.slug === 'string' && f.data.slug.trim()
+                ? slugify(f.data.slug)
+                : slugify(stem.replace(DATED, '').replace(NUMERIC, ''));
+            out.slugByFile.set(f.rel, slug);
+            out.posts.push({
+                file: f.rel,
+                slug,
+                title: titleOf(f.data, f.body, slug),
+                source: f.text,
+                body: f.body,
+                front,
+            });
+        }
+    };
+    walk(absDir);
+}
+function scanDocs(absDir, spec, out, read, fieldKeys) {
+    const rootName = spec.rootCollection ?? '';
+    const rootFiles = [];
+    const folders = [];
+    for (const e of (0, node_fs_1.readdirSync)(absDir).sort()) {
+        if (skipEntry(e))
+            continue;
+        const abs = (0, node_path_1.join)(absDir, e);
+        if ((0, node_fs_1.statSync)(abs).isDirectory()) {
+            if (hasMarkdown(abs))
+                folders.push(e);
+        }
+        else if (MD.test(e))
+            rootFiles.push(e);
+    }
+    if (rootFiles.length) {
+        out.collections.push(collectionOf(absDir, '', rootName ? slugify(rootName) : '', rootName, [-1, ''], {}, out, read, fieldKeys, rootFiles));
+    }
+    for (const name of folders) {
+        const abs = (0, node_path_1.join)(absDir, name);
+        const declared = { ...folderMeta(abs), ...(spec.collections?.[name] ?? {}) };
+        const [n, key] = prefixOrder(name);
+        const order = [typeof declared.order === 'number' ? declared.order : n, key];
+        const slug = typeof declared.slug === 'string'
+            ? slugify(declared.slug)
+            : slugify(name.replace(NUMERIC, ''));
+        const title = typeof declared.name === 'string' ? declared.name : titleize(name);
+        out.collections.push(collectionOf(abs, name, slug, title, order, (declared.nav ?? undefined), out, read, fieldKeys));
+    }
+    out.collections.sort((a, b) => a.order[0] - b.order[0] || a.order[1].localeCompare(b.order[1]));
+}
+function collectionOf(abs, dir, slug, name, order, nav, out, read, fieldKeys, onlyFiles) {
+    const col = { dir, slug, name, order, nav, pages: [] };
+    /**
+     * Walk one folder. `own` is the page that stands for this folder (its files
+     * nest under it; null at the collection's top) and `above` is the page that
+     * one nests under — which is where the folder's own index file hangs.
+     */
+    const walk = (folder, rel, own, above) => {
+        const entries = (onlyFiles ?? (0, node_fs_1.readdirSync)(folder).sort()).filter((e) => !skipEntry(e));
+        const files = entries.filter((e) => MD.test(e) && !(0, node_fs_1.statSync)((0, node_path_1.join)(folder, e)).isDirectory());
+        const dirs = onlyFiles
+            ? []
+            : entries.filter((e) => (0, node_fs_1.statSync)((0, node_path_1.join)(folder, e)).isDirectory() && hasMarkdown((0, node_path_1.join)(folder, e)));
+        const index = rel ? files.find(isIndex) : undefined;
+        for (const f of files) {
+            const parentSlug = f === index ? above : own;
+            const page = pageOf((0, node_path_1.join)(folder, f), rel ? `${rel}/${f}` : f, rel, f === index, parentSlug, slug, out, read, fieldKeys);
+            if (page)
+                col.pages.push(page);
+        }
+        for (const d of dirs) {
+            const sub = (0, node_path_1.join)(folder, d);
+            const subRel = rel ? `${rel}/${d}` : d;
+            const subFiles = (0, node_fs_1.readdirSync)(sub).filter((e) => !skipEntry(e) && MD.test(e));
+            const subIndex = subFiles.find(isIndex);
+            let folderSlug;
+            if (subIndex) {
+                // The index decides the folder page's address; read it once for that.
+                const { data } = (0, frontmatter_1.splitFront)((0, node_fs_1.readFileSync)((0, node_path_1.join)(sub, subIndex), 'utf8'));
+                folderSlug =
+                    typeof data.slug === 'string' && data.slug.trim()
+                        ? slugify(data.slug)
+                        : slugify(d.replace(NUMERIC, ''));
+            }
+            else {
+                folderSlug = slugify(d.replace(NUMERIC, ''));
+                const title = titleize(d);
+                col.pages.push({
+                    file: `${(0, node_path_1.relative)(out.absDir, sub).split(node_path_1.sep).join('/')}/ (no index.md)`,
+                    importName: `${subRel}/index.md`,
+                    slug: folderSlug,
+                    parentSlug: own,
+                    order: prefixOrder(d),
+                    title,
+                    source: `---\ntitle: ${JSON.stringify(title)}\nslug: ${folderSlug}\n---\n`,
+                    body: '',
+                    meta: {},
+                    unknown: [],
+                    stub: true,
+                });
+            }
+            walk(sub, subRel, folderSlug, own);
+        }
+    };
+    walk(abs, '', null, null);
+    return col;
+}
+function pageOf(abs, importName, rel, isFolderIndex, parentSlug, collectionSlug, out, read, fieldKeys) {
+    const f = read(abs);
+    if ((0, frontmatter_1.isDraft)(f.data)) {
+        out.warnings.push(`${f.rel}: draft — left out`);
+        return null;
+    }
+    const name = (0, node_path_1.basename)(abs);
+    const stem = name.replace(MD, '');
+    const declaredSlug = typeof f.data.slug === 'string' && f.data.slug.trim() ? slugify(f.data.slug) : '';
+    const folder = node_path_1.posix.basename(rel);
+    const atCollectionTop = isIndex(name) && !rel;
+    const slug = declaredSlug ||
+        (isFolderIndex
+            ? slugify(folder.replace(NUMERIC, ''))
+            : atCollectionTop
+                ? collectionSlug || slugify(titleOf(f.data, f.body, 'overview'))
+                : slugify(stem.replace(NUMERIC, '')));
+    const { meta, unknown } = (0, frontmatter_1.pageMeta)(f.data, fieldKeys);
+    const n = (0, frontmatter_1.declaredOrder)(f.data);
+    const [prefixN, key] = prefixOrder(isFolderIndex ? folder : stem);
+    // A folder's index is ordered among the folder's siblings, by the folder's
+    // prefix; a collection's own index leads it unless it says otherwise.
+    const order = [n ?? (atCollectionTop ? -1 : prefixN), key];
+    out.slugByFile.set(f.rel, slug);
+    return {
+        file: f.rel,
+        importName,
+        slug,
+        parentSlug,
+        order,
+        title: titleOf(f.data, f.body, slug),
+        source: f.text,
+        body: f.body,
+        meta,
+        unknown,
+    };
+}
+/** Every relative path → posix, for comparing with `importName`s. */
+const toPosix = (p) => p.split(node_path_1.sep).join('/');
+exports.toPosix = toPosix;
+const extOf = (p) => (0, node_path_1.extname)(p).toLowerCase();
+exports.extOf = extOf;
+//# sourceMappingURL=scan.js.map

package/dist/publish/scan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan.js","sourceRoot":"","sources":["../../src/publish/scan.ts"],"names":[],"mappings":";;;AAyBA,0BAaC;AAQD,wBAcC;AAGD,4BAGC;AAgFD,8BAqCC;AAvLD,qCAA0E;AAC1E,yCAA4F;AAC5F,+BAA0C;AAC1C,+CAA6E;AAG7E;;;;;;;;GAQG;AAEH,MAAM,EAAE,GAAG,uBAAuB,CAAC;AACnC,uEAAuE;AACvE,MAAM,KAAK,GAAG,4DAA4D,CAAC;AAC9D,QAAA,cAAc,GAAG,CAAC,iBAAiB,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;AACvF,MAAM,OAAO,GAAG,eAAe,CAAC;AAChC,MAAM,KAAK,GAAG,0BAA0B,CAAC;AACzC,MAAM,GAAG,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAEpC,+FAA+F;AAC/F,SAAgB,OAAO,CAAC,KAAa,EAAE,QAAQ,GAAG,MAAM;IACtD,OAAO,CACL,KAAK;SACF,SAAS,CAAC,KAAK,CAAC;SAChB,WAAW,EAAE;SACb,SAAS,CAAC,KAAK,CAAC;SAChB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,SAAS,CAAC,KAAK,CAAC;SAChB,OAAO,CAAC,4BAA4B,EAAE,GAAG,CAAC;SAC1C,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;SACZ,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,QAAQ,CAClC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,MAAM,CAAC,GAAW;IAChC,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC;SACxB,SAAS,CAAC,KAAK,CAAC;SAChB,WAAW,EAAE;SACb,SAAS,CAAC,KAAK,CAAC;SAChB,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;SAC/B,SAAS,CAAC,KAAK,CAAC;SAChB,OAAO,CAAC,gCAAgC,EAAE,GAAG,CAAC;SAC9C,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,OAAO,CAAC,iCAAiC,EAAE,EAAE,CAAC;SAC9C,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzB,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAClD,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC9C,CAAC;AAED,gDAAgD;AAChD,SAAgB,QAAQ,CAAC,IAAY;IACnC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACrE,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;AACxE,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,sCAAsC,CAAC,IAAI,CAAC,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC;AAC9F,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE,CACjC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;IACpB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;IACpB,IAAI,KAAK,cAAc;IACvB,sBAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAEhC,0EAA0E;AAC1E,SAAS,WAAW,CAAC,IAAY;IAC/B,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,KAAK,MAAM,CAAC,IAAI,IAAA,qBAAW,EAAC,GAAG,CAAC,EAAE,CAAC;QACjC,IAAI,SAAS,CAAC,CAAC,CAAC;YAAE,SAAS;QAC3B,MAAM,CAAC,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACvB,IAAI,IAAA,kBAAQ,EAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;IAC3E,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,yEAAyE;AACzE,SAAS,UAAU,CAAC,GAAW;IAC7B,KAAK,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAC5E,MAAM,CAAC,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACvB,IAAI,IAAA,oBAAU,EAAC,CAAC,CAAC;YAAE,OAAO,CAAC,IAAA,YAAS,EAAC,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAA4B,CAAC;IAClG,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,mGAAmG;AACnG,SAAS,OAAO,CAAC,KAA8B,EAAE,IAAY,EAAE,QAAgB;IAC7E,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACrF,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,MAAM,EAAE,GAAG,KAAK,IAAI,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtD,8EAA8E;IAC9E,iEAAiE;IACjE,MAAM,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;QACnB,EAAE,OAAO,CAAC,0BAA0B,EAAE,IAAI,CAAC;SAC1C,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;SACtB,IAAI,EAAE,CAAC;IACV,OAAO,KAAK,IAAI,QAAQ,CAAC;AAC3B,CAAC;AAED,sFAAsF;AACtF,SAAS,SAAS,CAChB,IAAY,EACZ,OAAe,EACf,KAA8B;IAE9B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE;QAC/B,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,CAAC;QACjE,IAAI,CAAC,KAAK,IAAI,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YAC7F,OAAO;QACT,MAAM,GAAG,GAAG,IAAA,mBAAO,EAAC,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/C,IAAI,IAAA,oBAAU,EAAC,GAAG,CAAC,IAAI,IAAA,kBAAQ,EAAC,GAAG,CAAC,CAAC,MAAM,EAAE;YAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;IAC3E,CAAC,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,qCAAqC,CAAC;QAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;IACtF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,+CAA+C,CAAC;QAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC;IAChG,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAE;QAC1B,IAAI,OAAO,CAAC,KAAK,QAAQ;YAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;aAClC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACtC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ;YAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC;IACF,IAAI,CAAC,KAAK,CAAC,CAAC;IACZ,OAAO,IAAI,CAAC;AACd,CAAC;AASD,kFAAkF;AAClF,SAAgB,SAAS,CACvB,IAAY,EACZ,IAAe,EACf,IAAsB,EACtB,SAAmB;IAEnB,MAAM,MAAM,GAAG,IAAA,mBAAO,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;IAC/C,MAAM,GAAG,GAAe;QACtB,GAAG,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;QACpB,MAAM;QACN,WAAW,EAAE,EAAE;QACf,KAAK,EAAE,EAAE;QACT,MAAM,EAAE,IAAI,GAAG,EAAE;QACjB,QAAQ,EAAE,EAAE;QACZ,IAAI,EAAE,IAAI,GAAG,EAAE;QACf,UAAU,EAAE,IAAI,GAAG,EAAE;KACtB,CAAC;IACF,IAAI,CAAC,IAAA,oBAAU,EAAC,MAAM,CAAC,IAAI,CAAC,IAAA,kBAAQ,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;QAC3D,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,kBAAkB,CAAC,CAAC;QAC/C,OAAO,GAAG,CAAC;IACb,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE;QAC3B,MAAM,IAAI,GAAG,IAAA,sBAAY,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACvC,MAAM,GAAG,GAAG,IAAA,oBAAQ,EAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,eAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAA,wBAAU,EAAC,IAAI,CAAC,CAAC;YACxC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,IAAA,mBAAO,EAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;YACjD,IAAI,IAAI,CAAC,IAAI;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACvC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;gBAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACjD,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;QACnC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,KAAM,CAAW,CAAC,OAAO,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC,CAAC;IACF,IAAI,IAAI,KAAK,OAAO;QAAE,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;;QAC9C,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAClD,OAAO,GAAG,CAAC;AACb,CAAC;AASD,SAAS,SAAS,CAAC,MAAc,EAAE,GAAe,EAAE,IAAY;IAC9D,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE;QAC3B,KAAK,MAAM,CAAC,IAAI,IAAA,qBAAW,EAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YACxC,IAAI,SAAS,CAAC,CAAC,CAAC;gBAAE,SAAS;YAC3B,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACzB,IAAI,IAAA,kBAAQ,EAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACV,SAAS;YACX,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;gBAAE,SAAS;YAC1B,mEAAmE;YACnE,IAAI,GAAG,KAAK,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3C,GAAG,CAAC,QAAQ,CAAC,IAAI,CACf,GAAG,CAAC,yEAAyE,CAC9E,CAAC;gBACF,SAAS;YACX,CAAC;YACD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACpB,IAAI,IAAA,qBAAO,EAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC;gBAChD,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YAC5B,IAAI,KAAK,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;gBACtE,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS;gBAC7D,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC;YACjC,MAAM,IAAI,GACR,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACnD,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;gBACtB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;YAC5D,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAChC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,CAAC,CAAC,GAAG;gBACX,IAAI;gBACJ,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC;gBACpC,MAAM,EAAE,CAAC,CAAC,IAAI;gBACd,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,KAAK;aACN,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CACf,MAAc,EACd,IAAe,EACf,GAAe,EACf,IAAY,EACZ,SAAmB;IAEnB,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,IAAI,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,CAAC,IAAI,IAAA,qBAAW,EAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC3C,IAAI,SAAS,CAAC,CAAC,CAAC;YAAE,SAAS;QAC3B,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5B,IAAI,IAAA,kBAAQ,EAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YAChC,IAAI,WAAW,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QACrB,GAAG,CAAC,WAAW,CAAC,IAAI,CAClB,YAAY,CACV,MAAM,EACN,EAAE,EACF,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,EACjC,QAAQ,EACR,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EACR,EAAE,EACF,GAAG,EACH,IAAI,EACJ,SAAS,EACT,SAAS,CACV,CACF,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC/B,MAAM,QAAQ,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC7E,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,KAAK,GAAqB,CAAC,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC/F,MAAM,IAAI,GACR,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ;YAC/B,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjF,GAAG,CAAC,WAAW,CAAC,IAAI,CAClB,YAAY,CACV,GAAG,EACH,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,EACL,CAAC,QAAQ,CAAC,GAAG,IAAI,SAAS,CAA4B,EACtD,GAAG,EACH,IAAI,EACJ,SAAS,CACV,CACF,CAAC;IACJ,CAAC;IACD,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClG,CAAC;AAED,SAAS,YAAY,CACnB,GAAW,EACX,GAAW,EACX,IAAY,EACZ,IAAY,EACZ,KAAuB,EACvB,GAAwC,EACxC,GAAe,EACf,IAAY,EACZ,SAAmB,EACnB,SAAoB;IAEpB,MAAM,GAAG,GAAoB,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACxE;;;;OAIG;IACH,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,GAAkB,EAAE,KAAoB,EAAE,EAAE;QACrF,MAAM,OAAO,GAAG,CAAC,SAAS,IAAI,IAAA,qBAAW,EAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACvF,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAA,kBAAQ,EAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC5F,MAAM,IAAI,GAAG,SAAS;YACpB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,OAAO,CAAC,MAAM,CACZ,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,kBAAQ,EAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,IAAI,WAAW,CAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAC/E,CAAC;QACN,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACpD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,UAAU,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;YAC7C,MAAM,IAAI,GAAG,MAAM,CACjB,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,EACf,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EACvB,GAAG,EACH,CAAC,KAAK,KAAK,EACX,UAAU,EACV,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,SAAS,CACV,CAAC;YACF,IAAI,IAAI;gBAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC5B,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAA,qBAAW,EAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7E,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,UAAkB,CAAC;YACvB,IAAI,QAAQ,EAAE,CAAC;gBACb,sEAAsE;gBACtE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAA,wBAAU,EAAC,IAAA,sBAAY,EAAC,IAAA,gBAAI,EAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBACvE,UAAU;oBACR,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;wBAC/C,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;wBACpB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAC1B,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,GAAG,IAAA,oBAAQ,EAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,eAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB;oBACxE,UAAU,EAAE,GAAG,MAAM,WAAW;oBAChC,IAAI,EAAE,UAAU;oBAChB,UAAU,EAAE,GAAG;oBACf,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;oBACrB,KAAK;oBACL,MAAM,EAAE,eAAe,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,UAAU,SAAS;oBAC1E,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,EAAE;oBACR,OAAO,EAAE,EAAE;oBACX,IAAI,EAAE,IAAI;iBACX,CAAC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACrC,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1B,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,MAAM,CACb,GAAW,EACX,UAAkB,EAClB,GAAW,EACX,aAAsB,EACtB,UAAyB,EACzB,cAAsB,EACtB,GAAe,EACf,IAAY,EACZ,SAAmB;IAEnB,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACpB,IAAI,IAAA,qBAAO,EAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,IAAI,GAAG,IAAA,oBAAQ,EAAC,GAAG,CAAC,CAAC;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAClC,MAAM,YAAY,GAChB,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,MAAM,GAAG,iBAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC9C,MAAM,IAAI,GACR,YAAY;QACZ,CAAC,aAAa;YACZ,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACtC,CAAC,CAAC,eAAe;gBACf,CAAC,CAAC,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBAChE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAA,sBAAQ,EAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACtD,MAAM,CAAC,GAAG,IAAA,2BAAa,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClE,2EAA2E;IAC3E,sEAAsE;IACtE,MAAM,KAAK,GAAqB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAC7E,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,OAAO;QACL,IAAI,EAAE,CAAC,CAAC,GAAG;QACX,UAAU;QACV,IAAI;QACJ,UAAU;QACV,KAAK;QACL,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC;QACpC,MAAM,EAAE,CAAC,CAAC,IAAI;QACd,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI;QACJ,OAAO;KACR,CAAC;AACJ,CAAC;AAED,qEAAqE;AAC9D,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,eAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAAhD,QAAA,OAAO,WAAyC;AACtD,MAAM,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,IAAA,mBAAO,EAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;AAAhD,QAAA,KAAK,SAA2C"}

package/dist/publish/types.d.ts

@@ -0,0 +1,155 @@
+/**
+ * The shapes `forumulate publish <folder>` works in.
+ *
+ * Three layers, kept apart on purpose: what is ON DISK (`Local*`), what is
+ * LIVE (`Live*`), and what would change (`Plan`). Every customer publisher we
+ * were shown (four of them, in three languages) mixed the first two — they
+ * wrote while they read — so a dry run was a different code path from the real
+ * one and drifted from it. Here a plan is computed from the two snapshots and
+ * nothing else, and the real run executes that same plan.
+ */
+/** A page's metadata patch, in the API's own field names (`PATCH …/metadata`). */
+export type MetaPatch = Record<string, unknown>;
+/** One Markdown file destined to be a docs page. */
+export interface LocalPage {
+    /** Path relative to the publish root, for the plan a person reads. */
+    file: string;
+    /** Path relative to its collection folder — the name the import door is sent. */
+    importName: string;
+    /** Where the page lands. Declared in front matter or derived from the file name. */
+    slug: string;
+    /** The folder page this one nests under, by slug; null at the collection's top. */
+    parentSlug: string | null;
+    /** Sort key among siblings: declared `order`, a numeric prefix, else the name. */
+    order: [number, string];
+    /** Front matter title, else the leading `# heading`, else the slug. */
+    title: string;
+    /** The file exactly as written, with `slug:` declared and references rewritten later. */
+    source: string;
+    /** The body without front matter — what is compared. */
+    body: string;
+    /** Metadata the front matter declares, mapped to API field names. */
+    meta: MetaPatch;
+    /** Front matter keys nothing here understands — reported, never sent. */
+    unknown: string[];
+    /** Synthesised to stand for a folder that has no index file of its own. */
+    stub?: boolean;
+}
+/** One top-level folder of a docs space. */
+export interface LocalCollection {
+    /** Folder name relative to the space folder; '' for files at the space root. */
+    dir: string;
+    slug: string;
+    name: string;
+    order: [number, string];
+    nav?: Record<string, unknown>;
+    pages: LocalPage[];
+}
+/** One Markdown file destined to be a post (blog, changelog, any non-docs type). */
+export interface LocalPost {
+    file: string;
+    slug: string;
+    title: string;
+    source: string;
+    body: string;
+    /** Front matter as written (keys lower-cased only where the type declares them). */
+    front: Record<string, unknown>;
+}
+/** Everything one space folder holds. */
+export interface LocalSpace {
+    /** The space folder, relative to the publish root ('' = the root itself). */
+    dir: string;
+    absDir: string;
+    collections: LocalCollection[];
+    posts: LocalPost[];
+    /** Local files (images, PDFs) referenced from pages or posts, absolute paths. */
+    assets: Set<string>;
+    warnings: string[];
+}
+/** A space as the manifest describes it. */
+export interface SpaceSpec {
+    /** Folder under the publish root. */
+    path: string;
+    /** Space id or slug. */
+    space?: string;
+    /** Create the space when it does not exist. */
+    create?: {
+        name?: string;
+        type?: string;
+        visibility?: 'PUBLIC' | 'PRIVATE';
+    };
+    name?: string;
+    visibility?: 'PUBLIC' | 'PRIVATE';
+    settings?: Record<string, unknown>;
+    theme?: Record<string, unknown>;
+    /** The collection files at the space root go into. */
+    rootCollection?: string;
+    /** Per-folder overrides: name, slug, order, nav. Keyed by folder name. */
+    collections?: Record<string, {
+        name?: string;
+        slug?: string;
+        order?: number;
+        nav?: Record<string, unknown>;
+    }>;
+    openapi?: OpenApiSpec[];
+    monitors?: Record<string, unknown>[];
+    /** Slugs (pages/posts) or collection slugs that `--prune` must never remove. */
+    keep?: string[];
+}
+export interface OpenApiSpec {
+    /** A file relative to the manifest, JSON or YAML. */
+    spec?: string;
+    /** Or a URL the API fetches itself. */
+    url?: string;
+    /** Collection name (found or created) the reference lands in. */
+    collection: string;
+    /** Everything else is passed to `POST …/docs/openapi/import` as written. */
+    [key: string]: unknown;
+}
+export interface SiteSpec {
+    id?: string;
+    slug?: string;
+    name?: string;
+    config?: Record<string, unknown>;
+}
+export interface Manifest {
+    /** Where the manifest was read from, or null when there is none. */
+    file: string | null;
+    org?: string;
+    site?: SiteSpec;
+    spaces: SpaceSpec[];
+}
+/** A live page, from `GET …/pages` (authenticated) or the public space (anonymous). */
+export interface LivePage {
+    id: string;
+    slug: string;
+    title: string;
+    collectionId: string;
+    parentId: string | null;
+    sortKey: string;
+    published: boolean;
+}
+export interface LiveCollection {
+    id: string;
+    slug: string;
+    name: string;
+    isDefault: boolean;
+    sortKey: string;
+    nav?: Record<string, unknown>;
+}
+export interface LivePost {
+    id: string;
+    slug: string;
+    title: string;
+    published: boolean;
+    markdown?: string;
+    sections?: Record<string, string>;
+}
+/** What a piece of the plan does — one line in the dry run, one or more calls in the real one. */
+export type Verb = 'create' | 'update' | 'meta' | 'move' | 'order' | 'prune' | 'upload' | 'patch' | 'import' | 'same' | 'skip' | 'warn';
+export interface PlanLine {
+    verb: Verb;
+    what: string;
+    detail?: string;
+}
+//# sourceMappingURL=types.d.ts.map