@krantho/server 0.0.0-stage → 1.0.0

package/dist/content-loader.d.ts

@@ -0,0 +1,37 @@
+import type { IPublishedContentLoader, IPublishedSeoLoader } from '@krantho/core';
+import type { KranthoHandlerOptions } from './handler.js';
+/** What server-rendered pages read: published content, the pages' SEO, and a preview view */
+export interface ContentLoader extends IPublishedContentLoader, IPublishedSeoLoader {
+    /**
+     * The same reads for an editor's preview: a document and its JSON-LD come
+     * from its current version, draft included, and nothing is cached
+     */
+    readonly preview: IPublishedContentLoader & IPublishedSeoLoader;
+}
+/**
+ * Create the content loader server-rendered pages read through.
+ *
+ * Pages read only the live (published) version of a document — never a newer
+ * draft — by collection, slug and locale; an omitted locale is the site's
+ * default. The loader takes the configuration and collections the API handler
+ * takes, opens persistence through the same factory, and runs the same startup
+ * content import and SEO seed before its first read returns — so pages and the
+ * API read one database, and a fresh one is filled and configured whichever of
+ * them a deployment serves first. The adapter opens on the first read, not at
+ * import time, and a failed open is retried on the next read. Reads are cached
+ * per `content.cache`, except with `cache.pages: 'next-isr'`, where Next.js
+ * caches them, and with `cache.pages: 'cdn'`, where
+ * the CDN caches the pages: a publish purges the CDN, and the next render must
+ * read the new version, not a cached one the CDN would then keep.
+ *
+ * It also serves the pages' SEO: configuration properties, and each page's
+ * JSON-LD composed from its published fields — in-process, the way the API's
+ * preview composes it, so no page calls the site's own API. Its `preview` view
+ * reads the current version instead, for an editor previewing a draft.
+ *
+ * Inside `runPageRequest()` every read records its cache tags into the
+ * request, and a preview request reads through the `preview` view;
+ * `isPreview()` says which a render reads.
+ */
+export declare function createContentLoader(options: Pick<KranthoHandlerOptions, 'config' | 'collections'>): ContentLoader;
+//# sourceMappingURL=content-loader.d.ts.map

package/dist/content-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-loader.d.ts","sourceRoot":"","sources":["../src/content-loader.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAEV,uBAAuB,EACvB,mBAAmB,EAGpB,MAAM,eAAe,CAAA;AAoBtB,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAWzD,6FAA6F;AAC7F,MAAM,WAAW,aAAc,SAAQ,uBAAuB,EAAE,mBAAmB;IACjF;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,uBAAuB,GAAG,mBAAmB,CAAA;CAChE;AAmBD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,IAAI,CAAC,qBAAqB,EAAE,QAAQ,GAAG,aAAa,CAAC,GAC7D,aAAa,CA4Cf"}

package/dist/content-loader.js

@@ -0,0 +1,223 @@
+import { mkdir } from 'node:fs/promises';
+import { dirname } from 'node:path';
+import { composePageJsonLd } from '@krantho/api';
+import { loadConfig } from '@krantho/config/node';
+import { documentPath, documentReadTags, jsonLdTags, listReadTags, pageCollection, seoReadTags, } from '@krantho/core';
+import { canGetContent, canReadPublished } from '@krantho/persistence';
+import { defineConfig } from '@krantho/schema';
+import { documentSeoProperties } from '@krantho/seo-shared';
+import { importRepositoryContent } from './content-migration.js';
+import { createLockAdapters } from './lock-adapters.js';
+import { inPreviewRequest, recordReadTags } from './page-request.js';
+import { createAdapter } from './persistence.js';
+import { createReadCache } from './read-cache.js';
+import { seedSeoOnce } from './seo-seed.js';
+const liveVersion = (reader, ref, locale) => reader.getPublished(ref.collection, ref.slug, locale);
+const currentVersion = async (reader, ref, locale) => {
+    // Every database adapter reads single documents; one that cannot previews nothing
+    if (!canGetContent(reader))
+        return null;
+    const doc = await reader.getContent(ref.collection, ref.slug, locale);
+    return doc && doc.meta.status !== 'deleted' ? doc : null;
+};
+/**
+ * Create the content loader server-rendered pages read through.
+ *
+ * Pages read only the live (published) version of a document — never a newer
+ * draft — by collection, slug and locale; an omitted locale is the site's
+ * default. The loader takes the configuration and collections the API handler
+ * takes, opens persistence through the same factory, and runs the same startup
+ * content import and SEO seed before its first read returns — so pages and the
+ * API read one database, and a fresh one is filled and configured whichever of
+ * them a deployment serves first. The adapter opens on the first read, not at
+ * import time, and a failed open is retried on the next read. Reads are cached
+ * per `content.cache`, except with `cache.pages: 'next-isr'`, where Next.js
+ * caches them, and with `cache.pages: 'cdn'`, where
+ * the CDN caches the pages: a publish purges the CDN, and the next render must
+ * read the new version, not a cached one the CDN would then keep.
+ *
+ * It also serves the pages' SEO: configuration properties, and each page's
+ * JSON-LD composed from its published fields — in-process, the way the API's
+ * preview composes it, so no page calls the site's own API. Its `preview` view
+ * reads the current version instead, for an editor previewing a draft.
+ *
+ * Inside `runPageRequest()` every read records its cache tags into the
+ * request, and a preview request reads through the `preview` view;
+ * `isPreview()` says which a render reads.
+ */
+export function createContentLoader(options) {
+    let resolved;
+    let opening = null;
+    let cache;
+    function settings() {
+        resolved ??= loadConfig({ code: options.config, env: process.env });
+        return resolved;
+    }
+    function store() {
+        opening ??= openStore(settings(), defineConfig({ collections: options.collections })).catch((err) => {
+            opening = null;
+            throw err;
+        });
+        return opening;
+    }
+    function reads() {
+        // With Next.js ISR, Next's data cache is the only page-side cache; behind a CDN, the CDN is
+        const { content, cache: pageCache } = settings();
+        const cachedElsewhere = pageCache.pages === 'next-isr' || pageCache.pages === 'cdn';
+        cache ??= createReadCache(cachedElsewhere ? { ...content.cache, enabled: false } : content.cache);
+        return cache;
+    }
+    const uncached = createReadCache({ enabled: false, ttlMs: 0, maxEntries: 1 });
+    const view = (version, isPreview, cached) => readView({
+        settings,
+        store,
+        version,
+        preview: isPreview,
+        cache: cached,
+        collections: options.collections,
+    });
+    const live = view(liveVersion, false, reads);
+    const preview = view(currentVersion, true, () => uncached);
+    return { ...previewInScope(live, preview), preview };
+}
+/** The live view, served from the preview view while a preview page request runs */
+function previewInScope(live, preview) {
+    const active = () => (inPreviewRequest() ? preview : live);
+    return {
+        isPreview: () => active().isPreview(),
+        getPublished: (ref) => active().getPublished(ref),
+        listPublished: (collection, locale) => active().listPublished(collection, locale),
+        listPublishedSummaries: (collection, locale) => active().listPublishedSummaries(collection, locale),
+        seoProperties: (configId, locale) => active().seoProperties(configId, locale),
+        jsonLd: (ref, structure) => active().jsonLd(ref, structure),
+    };
+}
+/**
+ * The site's identity from configuration, which the primary site entity
+ * carries unless its SEO settings set a value of their own
+ */
+function siteIdentity(site) {
+    const identity = { name: site.name, url: site.baseUrl };
+    if (site.logo)
+        identity['logo'] = site.logo;
+    if (site.description)
+        identity['description'] = site.description;
+    if (site.alternateName)
+        identity['alternateName'] = site.alternateName;
+    if (site.sameAs.length > 0)
+        identity['sameAs'] = site.sameAs;
+    return identity;
+}
+/** The page reads over one version of each document; each records its tags into the page request */
+function readView({ settings, store, version, preview, cache, collections, }) {
+    const localeOf = (ref) => ref.locale ?? settings().site.defaultLocale;
+    return {
+        isPreview: async () => preview,
+        getPublished: (ref) => {
+            recordReadTags(documentReadTags(ref.collection, ref.slug));
+            const locale = localeOf(ref);
+            return cache().read(`doc:${ref.collection}:${ref.slug}:${locale}`, async () => {
+                const doc = await version((await store()).adapter, ref, locale);
+                return doc ? toPublished(doc) : null;
+            });
+        },
+        listPublished: (collection, locale) => {
+            recordReadTags(listReadTags(collection));
+            const loc = locale ?? settings().site.defaultLocale;
+            return cache().read(`list:${collection}:${loc}`, async () => {
+                const { items } = await (await store()).adapter.query({
+                    state: 'published',
+                    projection: 'full',
+                    collections: [collection],
+                    locale: loc,
+                });
+                return items.map(toPublished);
+            });
+        },
+        listPublishedSummaries: (collection, locale) => {
+            recordReadTags(listReadTags(collection));
+            const loc = locale ?? settings().site.defaultLocale;
+            return cache().read(`summaries:${collection}:${loc}`, async () => {
+                const { items } = await (await store()).adapter.query({
+                    state: 'published',
+                    projection: 'summary',
+                    collections: [collection],
+                    locale: loc,
+                });
+                return items.map(toPublishedSummary);
+            });
+        },
+        seoProperties: (configId, locale) => {
+            recordReadTags(seoReadTags(configId));
+            return cache().read(`seo:${configId}:${locale ?? settings().site.defaultLocale}`, async () => {
+                if (configId.startsWith('doc:')) {
+                    const key = configId.slice(4);
+                    const slash = key.indexOf('/');
+                    if (slash < 1)
+                        return {};
+                    const ref = { collection: key.slice(0, slash), slug: key.slice(slash + 1), locale };
+                    recordReadTags(documentReadTags(ref.collection, ref.slug));
+                    const doc = await version((await store()).adapter, ref, localeOf(ref));
+                    return doc ? documentSeoProperties(doc.metadata) : {};
+                }
+                const entry = await (await store()).seoConfigs?.getConfig(configId);
+                const properties = entry?.config.entities[0]?.properties ?? {};
+                return configId === 'site'
+                    ? { ...siteIdentity(settings().site), ...properties }
+                    : properties;
+            });
+        },
+        // Document SEO configuration is per document, shared by its locales; the
+        // graph is composed from the requested locale's fields.
+        jsonLd: (ref, structure) => {
+            recordReadTags(jsonLdTags(ref.collection, ref.slug));
+            const locale = localeOf(ref);
+            const shape = structure ? `:${JSON.stringify(structure)}` : '';
+            return cache().read(`jsonld:${ref.collection}:${ref.slug}:${locale}${shape}`, async () => {
+                const { adapter, seoConfigs } = await store();
+                const doc = await version(adapter, ref, locale);
+                if (!doc)
+                    return null;
+                return composePageJsonLd({
+                    collection: ref.collection,
+                    slug: ref.slug,
+                    path: documentPath(pageCollection(collections, ref.collection), ref.slug),
+                    fields: doc.fields,
+                    metadata: doc.metadata,
+                    documentMeta: doc.meta,
+                    config: settings(),
+                    seoConfigs,
+                    structure,
+                });
+            });
+        },
+    };
+}
+async function openStore(config, contentConfig) {
+    if (config.persistence.provider === 'sqlite') {
+        await mkdir(dirname(config.persistence.sqlite.path), { recursive: true });
+    }
+    const { adapter, lockDb, contentMigrationAdapter, checkpointAdapter } = await createAdapter(config.persistence, config.site, config.content, contentConfig.collections);
+    await importRepositoryContent(adapter, contentConfig, contentMigrationAdapter, checkpointAdapter, config.paths.contentDir, config.content.defaultStatus.filesystem);
+    if (!canReadPublished(adapter)) {
+        throw new Error(`The ${config.persistence.provider} persistence adapter cannot read published content`);
+    }
+    const { seoConfigAdapter } = await createLockAdapters(lockDb, config.persistence.provider);
+    if (seoConfigAdapter)
+        await seedSeoOnce(config, seoConfigAdapter);
+    return { adapter, seoConfigs: seoConfigAdapter };
+}
+function toPublishedSummary(doc) {
+    return {
+        collection: doc.meta.collection,
+        slug: doc.meta.slug,
+        locale: doc.meta.locale,
+        metadata: doc.metadata,
+        fields: doc.fields,
+        publishedAt: new Date(doc.meta.createdAt),
+    };
+}
+function toPublished(doc) {
+    return { ...toPublishedSummary(doc), body: doc.body };
+}
+//# sourceMappingURL=content-loader.js.map

package/dist/content-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-loader.js","sourceRoot":"","sources":["../src/content-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAQjD,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,cAAc,EACd,WAAW,GACZ,MAAM,eAAe,CAAA;AAOtB,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEtE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAA;AAEhE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAEhD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAqB3C,MAAM,WAAW,GAAkB,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CACzD,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AAEvD,MAAM,cAAc,GAAkB,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;IAClE,kFAAkF;IAClF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAA;IACvC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACrE,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;AAC1D,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAA8D;IAE9D,IAAI,QAAmC,CAAA;IACvC,IAAI,OAAO,GAA8B,IAAI,CAAA;IAC7C,IAAI,KAA4B,CAAA;IAEhC,SAAS,QAAQ;QACf,QAAQ,KAAK,UAAU,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;QACnE,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,SAAS,KAAK;QACZ,OAAO,KAAK,SAAS,CAAC,QAAQ,EAAE,EAAE,YAAY,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CACzF,CAAC,GAAY,EAAE,EAAE;YACf,OAAO,GAAG,IAAI,CAAA;YACd,MAAM,GAAG,CAAA;QACX,CAAC,CACF,CAAA;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,SAAS,KAAK;QACZ,4FAA4F;QAC5F,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,CAAA;QAChD,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,KAAK,UAAU,IAAI,SAAS,CAAC,KAAK,KAAK,KAAK,CAAA;QACnF,KAAK,KAAK,eAAe,CACvB,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CACvE,CAAA;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAA;IAC7E,MAAM,IAAI,GAAG,CAAC,OAAsB,EAAE,SAAkB,EAAE,MAAuB,EAAE,EAAE,CACnF,QAAQ,CAAC;QACP,QAAQ;QACR,KAAK;QACL,OAAO;QACP,OAAO,EAAE,SAAS;QAClB,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,OAAO,CAAC,WAAW;KACjC,CAAC,CAAA;IAEJ,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;IAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAA;IAC1D,OAAO,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,CAAA;AACtD,CAAC;AAED,oFAAoF;AACpF,SAAS,cAAc,CAAC,IAAoB,EAAE,OAAuB;IACnE,MAAM,MAAM,GAAG,GAAmB,EAAE,CAAC,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAC1E,OAAO;QACL,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE;QACrC,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC;QACjD,aAAa,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC;QACjF,sBAAsB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAC7C,MAAM,EAAE,CAAC,sBAAsB,CAAC,UAAU,EAAE,MAAM,CAAC;QACrD,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC7E,MAAM,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC;KAC5D,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAC,IAA2B;IAC/C,MAAM,QAAQ,GAA4B,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,CAAA;IAChF,IAAI,IAAI,CAAC,IAAI;QAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAA;IAC3C,IAAI,IAAI,CAAC,WAAW;QAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAA;IAChE,IAAI,IAAI,CAAC,aAAa;QAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAA;IACtE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAA;IAC5D,OAAO,QAAQ,CAAA;AACjB,CAAC;AAaD,oGAAoG;AACpG,SAAS,QAAQ,CAAC,EAChB,QAAQ,EACR,KAAK,EACL,OAAO,EACP,OAAO,EACP,KAAK,EACL,WAAW,GACK;IAChB,MAAM,QAAQ,GAAG,CAAC,GAAe,EAAU,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC,IAAI,CAAC,aAAa,CAAA;IACzF,OAAO;QACL,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO;QAC9B,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE;YACpB,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;YAC1D,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;YAC5B,OAAO,KAAK,EAAE,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,IAAI,MAAM,EAAE,EAAE,KAAK,IAAI,EAAE;gBAC5E,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAA;gBAC/D,OAAO,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACtC,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,aAAa,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE;YACpC,cAAc,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;YACxC,MAAM,GAAG,GAAG,MAAM,IAAI,QAAQ,EAAE,CAAC,IAAI,CAAC,aAAa,CAAA;YACnD,OAAO,KAAK,EAAE,CAAC,IAAI,CAAC,QAAQ,UAAU,IAAI,GAAG,EAAE,EAAE,KAAK,IAAI,EAAE;gBAC1D,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;oBACpD,KAAK,EAAE,WAAW;oBAClB,UAAU,EAAE,MAAM;oBAClB,WAAW,EAAE,CAAC,UAAU,CAAC;oBACzB,MAAM,EAAE,GAAG;iBACZ,CAAC,CAAA;gBACF,OAAO,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YAC/B,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,sBAAsB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE;YAC7C,cAAc,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAA;YACxC,MAAM,GAAG,GAAG,MAAM,IAAI,QAAQ,EAAE,CAAC,IAAI,CAAC,aAAa,CAAA;YACnD,OAAO,KAAK,EAAE,CAAC,IAAI,CAAC,aAAa,UAAU,IAAI,GAAG,EAAE,EAAE,KAAK,IAAI,EAAE;gBAC/D,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;oBACpD,KAAK,EAAE,WAAW;oBAClB,UAAU,EAAE,SAAS;oBACrB,WAAW,EAAE,CAAC,UAAU,CAAC;oBACzB,MAAM,EAAE,GAAG;iBACZ,CAAC,CAAA;gBACF,OAAO,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;YACtC,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;YAClC,cAAc,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAA;YACrC,OAAO,KAAK,EAAE,CAAC,IAAI,CACjB,OAAO,QAAQ,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,EAC5D,KAAK,IAAI,EAAE;gBACT,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBAChC,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;oBAC7B,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;oBAC9B,IAAI,KAAK,GAAG,CAAC;wBAAE,OAAO,EAAE,CAAA;oBACxB,MAAM,GAAG,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAA;oBACnF,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;oBAC1D,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;oBACtE,OAAO,GAAG,CAAC,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;gBACvD,CAAC;gBACD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;gBACnE,MAAM,UAAU,GAAG,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,IAAI,EAAE,CAAA;gBAC9D,OAAO,QAAQ,KAAK,MAAM;oBACxB,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE;oBACrD,CAAC,CAAC,UAAU,CAAA;YAChB,CAAC,CACF,CAAA;QACH,CAAC;QACD,yEAAyE;QACzE,wDAAwD;QACxD,MAAM,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE;YACzB,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;YACpD,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;YAC5B,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;YAC9D,OAAO,KAAK,EAAE,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,IAAI,MAAM,GAAG,KAAK,EAAE,EAAE,KAAK,IAAI,EAAE;gBACvF,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,KAAK,EAAE,CAAA;gBAC7C,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAA;gBAC/C,IAAI,CAAC,GAAG;oBAAE,OAAO,IAAI,CAAA;gBACrB,OAAO,iBAAiB,CAAC;oBACvB,UAAU,EAAE,GAAG,CAAC,UAAU;oBAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,IAAI,EAAE,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC;oBACzE,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,QAAQ,EAAE,GAAG,CAAC,QAAQ;oBACtB,YAAY,EAAE,GAAG,CAAC,IAAI;oBACtB,MAAM,EAAE,QAAQ,EAAE;oBAClB,UAAU;oBACV,SAAS;iBACV,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC;KACF,CAAA;AACH,CAAC;AAQD,KAAK,UAAU,SAAS,CAAC,MAAqB,EAAE,aAA4B;IAC1E,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC7C,MAAM,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC3E,CAAC;IACD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,GAAG,MAAM,aAAa,CACzF,MAAM,CAAC,WAAW,EAClB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,OAAO,EACd,aAAa,CAAC,WAAW,CAC1B,CAAA;IACD,MAAM,uBAAuB,CAC3B,OAAO,EACP,aAAa,EACb,uBAAuB,EACvB,iBAAiB,EACjB,MAAM,CAAC,KAAK,CAAC,UAAU,EACvB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CACxC,CAAA;IACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,OAAO,MAAM,CAAC,WAAW,CAAC,QAAQ,oDAAoD,CACvF,CAAA;IACH,CAAC;IACD,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC1F,IAAI,gBAAgB;QAAE,MAAM,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IACjE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAA;AAClD,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAmB;IAC7C,OAAO;QACL,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,UAAU;QAC/B,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI;QACnB,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM;QACvB,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,WAAW,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC;KAC1C,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,GAAoB;IACvC,OAAO,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAA;AACvD,CAAC"}

package/dist/content-migration.d.ts

@@ -0,0 +1,101 @@
+import { type ContentDocument, type ContentManifest, type ICheckpointAdapter, type IContentMigrationAdapter, type IPersistenceAdapter, type ISiteSettingsAdapter } from '@krantho/persistence';
+import { type ContentConfig, type ParsedRepositoryContent } from '@krantho/schema';
+import type { ImportableAdapter } from './import.js';
+/** An adapter the migration can import into and read each document's current version from */
+export interface MigratableAdapter extends ImportableAdapter {
+    getContent(collection: string, slug: string, locale?: string | undefined): Promise<ContentDocument | null>;
+}
+/** What the migration did with one content file */
+export type FileOutcome = 
+/** New or changed in the repository, and not edited in Studio: imported */
+'imported'
+/** The database already holds the file's content */
+ | 'unchanged'
+/** Edited in Studio while the file stayed the same: the editor's version stands */
+ | 'kept'
+/** Changed in the repository and edited in Studio: recorded as a conflict */
+ | 'conflict'
+/** Imported before and deleted in Studio since: stays deleted */
+ | 'deleted'
+/** The file fails its collection's schema */
+ | 'rejected';
+/** Per-file migration detail */
+export interface ImportDetail {
+    collection: string;
+    slug: string;
+    outcome: FileOutcome;
+}
+/** Result of running content migration on startup */
+export interface ContentMigrationResult {
+    action: 'skip' | 'full-import' | 'migrate';
+    imported: number;
+    conflicts: number;
+    rejected: number;
+    checkpointVersion: number | null;
+    reason?: string | undefined;
+    details: ImportDetail[];
+}
+/** A content file read from the repository, ready to compare and import */
+interface RepositoryFile {
+    key: string;
+    collection: string;
+    slug: string;
+    filePath: string;
+    /** SHA-256 of the file as it is on disk — what the manifest records */
+    fileChecksum: string;
+    /** Schema-validated fields, or null when the file fails its schema */
+    fields: Record<string, unknown> | null;
+    /** Why the file fails its schema */
+    issues: readonly string[];
+    body: string;
+    document?: ParsedRepositoryContent | undefined;
+    status?: string | undefined;
+}
+/**
+ * Bring the database up to date with the repository's content on startup.
+ *
+ * Without `<contentDir>/manifest.json` (or a migration adapter) the content is
+ * imported into an empty database only. With one, every deployment whose
+ * manifest is newer than the database's compares each file with its document:
+ * a new or changed file is imported, unless an editor changed the document in
+ * Studio since — then the editor's version stands and a changed file is
+ * recorded as a conflict. A document deleted in Studio stays deleted.
+ */
+export declare function runContentMigration(adapter: MigratableAdapter, contentConfig: ContentConfig, migrationAdapter: IContentMigrationAdapter | undefined, checkpointAdapter: ICheckpointAdapter | undefined, contentDir: string, defaultStatus?: string): Promise<ContentMigrationResult>;
+/**
+ * What to do with one repository file, given its document's current version
+ * and the file's checksum when the database last took the repository's
+ * content (undefined: the database never saw this file).
+ *
+ * Content equal to a state the repository held (the document's basis, or what
+ * the last deployment took) is not an edit: a document that carries the
+ * repository's previous file, as one does after a pull of production's edits was
+ * merged, is not reported as edited, and a file at that state is not reported as changed.
+ *
+ * A version an import wrote is not an edit either, whatever its checksum: nobody changed it since,
+ * even when it predates the document's basis and contract. A restore copies the restored version's
+ * source but always names who restored it, so only a version with no `changedBy` is an import's.
+ */
+export declare function decideFile(file: Pick<RepositoryFile, 'fileChecksum' | 'fields' | 'body' | 'document'>, current: ContentDocument | null, previousChecksum: string | undefined): FileOutcome;
+/** Read `<contentDir>/manifest.json`, or null when the build wrote none */
+export declare function loadManifest(contentDir: string): Promise<ContentManifest | null>;
+/** Canonical authored content checksum, independent of YAML spelling and key order. */
+export declare function contentChecksum(fields: Record<string, unknown>, body: string): string;
+/**
+ * Import the repository's content into the database when it needs it (an
+ * empty database, or a newer content manifest), logging what happened. Both
+ * the API handler and the page loader run it on first use, so whichever a
+ * fresh deployment serves first finds the content in place.
+ *
+ * @returns how many documents were imported
+ */
+export declare function importRepositoryContent(adapter: IPersistenceAdapter, contentConfig: ContentConfig, migrationAdapter: IContentMigrationAdapter | undefined, checkpointAdapter: ICheckpointAdapter | undefined, contentDir: string, defaultStatus?: string): Promise<number>;
+/**
+ * Whether the database holds a content version the site has not announced
+ * yet, recording it as announced. The page loader can import a deployment's
+ * content before the API handler starts, and only the handler can announce a
+ * change, so it announces each new content version once, whoever imported it.
+ */
+export declare function claimContentAnnouncement(migrationAdapter: IContentMigrationAdapter | undefined, settings: ISiteSettingsAdapter | undefined): Promise<boolean>;
+export {};
+//# sourceMappingURL=content-migration.d.ts.map

package/dist/content-migration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-migration.d.ts","sourceRoot":"","sources":["../src/content-migration.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,eAAe,EAEpB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EAE1B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACL,KAAK,aAAa,EAElB,KAAK,uBAAuB,EAG7B,MAAM,iBAAiB,CAAA;AAIxB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAIpD,6FAA6F;AAC7F,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,GAC1B,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAAA;CACnC;AAED,mDAAmD;AACnD,MAAM,MAAM,WAAW;AACrB,2EAA2E;AACzE,UAAU;AACZ,oDAAoD;GAClD,WAAW;AACb,mFAAmF;GACjF,MAAM;AACR,6EAA6E;GAC3E,UAAU;AACZ,iEAAiE;GAC/D,SAAS;AACX,6CAA6C;GAC3C,UAAU,CAAA;AAEd,gCAAgC;AAChC,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,WAAW,CAAA;CACrB;AAED,qDAAqD;AACrD,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;IAC1C,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,OAAO,EAAE,YAAY,EAAE,CAAA;CACxB;AAED,2EAA2E;AAC3E,UAAU,cAAc;IACtB,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,uEAAuE;IACvE,YAAY,EAAE,MAAM,CAAA;IACpB,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACtC,oCAAoC;IACpC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAC9C,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,iBAAiB,EAC1B,aAAa,EAAE,aAAa,EAC5B,gBAAgB,EAAE,wBAAwB,GAAG,SAAS,EACtD,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,EACjD,UAAU,EAAE,MAAM,EAClB,aAAa,GAAE,MAAoB,GAClC,OAAO,CAAC,sBAAsB,CAAC,CA+DjC;AA0BD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE,cAAc,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC,EAC3E,OAAO,EAAE,eAAe,GAAG,IAAI,EAC/B,gBAAgB,EAAE,MAAM,GAAG,SAAS,GACnC,WAAW,CAeb;AAgKD,2EAA2E;AAC3E,wBAAsB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAgBtF;AAED,uFAAuF;AACvF,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAErF;AAED;;;;;;;GAOG;AACH,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE,mBAAmB,EAC5B,aAAa,EAAE,aAAa,EAC5B,gBAAgB,EAAE,wBAAwB,GAAG,SAAS,EACtD,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,EACjD,UAAU,EAAE,MAAM,EAClB,aAAa,GAAE,MAAoB,GAClC,OAAO,CAAC,MAAM,CAAC,CAkBjB;AAKD;;;;;GAKG;AACH,wBAAsB,wBAAwB,CAC5C,gBAAgB,EAAE,wBAAwB,GAAG,SAAS,EACtD,QAAQ,EAAE,oBAAoB,GAAG,SAAS,GACzC,OAAO,CAAC,OAAO,CAAC,CAOlB"}